18.10 Webservice REST

Impostazioni Webservice REST

Nel CRM è possibile esporre e visionare dei servizi web (qui riferiti come webservice, o webservice REST), per far si che una applicazione esterna possa interagire con il CRM stesso, sfruttando il paradigma REST. Un webservice è accessibile tramite un indirizzo URL (qui riferito come endpoint), solitamente formato dall'indirizzo URL della installazione di vte, seguito da /restapi/v1/vtews/, e dal nome del metodo associato all'endpoint interessato.

Una volta configurato, è quindi possibile tramite richieste HTTP invocare endpoint specifici per eseguire l'azione richiesta.

Formato richieste HTTP

Le richieste supportano unicamente il metodo POST e il tipo di autenticazione Basic, ossia il passaggio tra i campi header di Authorization definito come Basic <credenziali>, dove <credenziali> è la codifica in Base64 del nome utente e della accesskey, separati da :.

Le richieste ai webservice sono pensate per restituire una risposta in formato JSON: in caso di successo restituiscono uno stato e i dati elaborati dall'endpoint, mentre in caso di errore restituiscono il codice di errore e la relativa descrizione.

Selettore utente e visualizzazione accesskey, lista moduli e campi utilizzabili

Tramite l'apposita picklist, associata a Nome Utente, è possibile selezionare l'utente interessato; questo permette, tramite pulsanti appositi, di visualizzarne gli accesskey e i moduli accessibili per le richieste dall'utente selezionato.

Il pulsante associato a Webservice accesskey permette di mostraremostrare, previo inserimento della propria password, gli accesskey generati dall'utente: questi vengono usati per autorizzare le richieste ai webservice, come osservato nel paragrafo Formato richieste HTTP. Da notare che per aggiungere ulteriori accesskey, l'utente deve accedere alle proprio preferenze, nella sezione Configurazione servizi web REST.

Pagina Documentazione REST (OpenAPI)

Cliccando il pulsante associato a Mostra Documentazione REST, è possibile accedere alla pagina adibita alla visualizzazione degli endpoint esposti dal CRM. Inizialmente vuota, basterà cliccare su Genera Documentazione OpenAPI per ottenere la definizione degli endpoint che verrà usata per la loro impaginazione.

E' quindi possibile testare i singoli endpoint premendo il pulsante Test Request per l'endpoint interessato, posto nel riquadro di esempio adiacente alla descrizione del metodo.