User API - Guida all'utilizzo dei Web Service - Introduzione

Il presente documento ha lo scopo di illustrare le funzionalità esposte attraverso i web services, dall'applicazione Infomail. Non tutte le funzionalità accessibili attraverso l'utilizzo dell'interfaccia web sono rese disponibili come web service.
Un utente deve essere esplicitamente abilitato per poter usufruire dei metodi di seguito documentati. Una volta che l'utente viene esplicitamente abilitato dall'amministratore all'utilizzo dei Web Services può utilizzare le proprie credenziali per autenticarsi ed ottenere l'autorizzazione all'utilizzo degli stessi, tramite il servizio di login (LoginService).
Per autenticarsi occorre fornire oltre il nome utente e la password anche il dominio. Il nome utente e password sono le stesse che si utilizzano per accedere attraverso l'interfaccia web. Il dominio è quello a cui ci si collega per utilizzare l'applicazione web.

Si può fruire dei web services di seguito descritti attraverso lo sviluppo di un client nel linguaggio che si preferisce che comunichi con i web services attraverso il protocollo SOAP 2.0 over http.

Guida alle API

La guida fornisce la descrizione di:

Le pagine della guida riguardanti i servizi elencano le richieste che il servizio gestisce. Le richieste prendono dei parametri di input e restituiscono una risposta. Sia i parametri di input che la risposta possono essere o dati semplici (per esempio un int) od oggetti (data objects) come MapElement.

Le pagine della guida riguardanti gli oggetti elencano i campi presenti e che cosa rappresentano. Il modo in cui vengono costruiti la richiesta e i parametri di input, dipende dallo strumento e dal linguaggio che si sta utilizzando, o dal fatto che si sta sviluppando direttamente in XML.

Per applicare ciò che viene descritto nella guida occorrerà mappare gli oggetti ed i campi per adattarli alla particolare situazione in esame.