18.10 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....
Una volta configurato, è quindi possibile tramite richieste HTTP invocare endpoint specifici per eseguire l'azione richiesta.
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 paginapassword, separati da :.
+Le richieste ai webservice sono pensate per restituire una risposta in formato JSON, con uno stato e i dati richiesti in caso di successo, o un codice di errore e relativa descrizione in caso di errore.
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 swaggerottenere 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.
