# 18.10 Webservice REST

### Impostazioni Webservice REST

Nelle impostazioni del CRM è possibile visionare i servizi web disponibili (qui riferiti come *webservice*, o *webservice REST*), per far si che applicazioni esterne possano interagire con il CRM stesso, sfruttando il [paradigma REST](https://it.wikipedia.org/wiki/Representational_state_transfer). 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 gli endpoint desiderati per eseguire le azioni richieste.

[![webservice-rest-it.png](https://usermanual.vtenext.com/uploads/images/gallery/2026-07/scaled-1680-/webservice-rest-it.png)](https://usermanual.vtenext.com/uploads/images/gallery/2026-07/webservice-rest-it.png)

#### Formato richieste HTTP

Le richieste HTTP 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 HTTP dall'utente selezionato.

Il pulsante associato a `Webservice accesskey` permette di mostrare, 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 proprie preferenze, nella sezione *Configurazione servizi web REST*: si rimanda alla [sezione dedicata alle preferenze utente](https://usermanual.vtenext.com/books/manuale-vtenext-2607/page/27-preferenze-utente).

Il pulsante associato a `Lista di moduli e campi utilizzabili` permette di visualizzare l'elenco dei moduli disponibili per l'utente e il loro nome interno, da usare nelle richieste ai webservice ove richiesto.

### 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`, posto nel riquadro di esempio adiacente alla descrizione del metodo, per l'endpoint e l'utente interessato. L'utente si può selezionare tramite l'apposito selettore, posto centralmente in alto nella pagina.

[![webservice-rest-openapi-it.png](https://usermanual.vtenext.com/uploads/images/gallery/2026-07/webservice-rest-openapi-it.png)](https://usermanual.vtenext.com/uploads/images/gallery/2026-07/webservice-rest-openapi-it.png)

Gli endpoint sono visualizzabili scrollando direttamente nella pagina, cliccando sugli endpoint elencati nella barra laterale, oppure cercandoli tramite la barra di ricerca posta sopra l'elenco degli endpoint (che è possibile aprire anche con la combinazioni di tasti `CTRL-K`, o `CMD-K` in macOS). Ogni singolo endpoint ha quindi visibile il corpo della richiesta, le possibili risposte, ed eventuali esempi di esse.

[![webservice-rest-openapi-request-it.png](https://usermanual.vtenext.com/uploads/images/gallery/2026-07/webservice-rest-openapi-request-it.png)](https://usermanual.vtenext.com/uploads/images/gallery/2026-07/webservice-rest-openapi-request-it.png)

### Configurazione Web service esterni per utilizzo nei processi

Nella pagina delle impostazioni è possibile aggiungere client web service esterni, basati su Zapier (si rimanda al [capitolo dedicato](https://usermanual.vtenext.com/books/manuale-vtenext-2607/page/157-sincronizzazione-con-zapier)), o impostazioni personalizzate.

Una volta configurati e attivati, tramite il pulsante `Aggiungi Client Webservice` e compilazione dei settaggi richiesti, possono essere visionati nella sezione `Lista webservice client configurati`, e utilizzati nei processi.

### Informazioni aggiuntive

Puoi vedere ulteriori [informazioni tecniche sui Webservice REST qui](https://usermanual.vtenext.com/books/developers/page/webservice-rest) (in inglese).