REST API

Descrive le Restful API

Lara Litrico avatar
Scritto da Lara Litrico
Aggiornato oltre una settimana fa

Introduzione

Le APIs di Contabilità in Cloud sono RESTful API basate sul protocollo HTTP e il formato JSON.

Autenticazione demo

Se si desidera provare le APIs prima di richiedere l'attivazione di un contratto come sviluppatore, è possibile farlo con un contratto demo speciale. Ci sono due modi per farlo.

Via query string

Il primo modo è molto semplice. Basta aggiungere la query-string ?demo=true al proprio request URL. Si ha bisogno solo di questo sin dalla prima chiamata e poi per tutte le chiamate API successive basta aggiungere quella query-string. Tutti i responses "401 Not Authorized" includono questo collegamento demo per quella risorsa. Questo permette una facile navigazione delle API quando si vuole scoprire cosa è disponibile.

Leggere qui per ulteriori informazioni.

Via headers

Il secondo modo è quello che permette un'applicazione facile "hello world". Questo imita il flusso di autenticazione che si dovrà utilizzare quando si crea la propria app. Basta specificare gli HTTP header tokens X-AgreementGrantToken: demo e X-AppSecretToken: demo. In questo modo è possibile creare un'applicazione e connettersi proprio come si farebbe se si avesse una reale integrazione. Ma senza la necessità di registrarsi.

N.B.: Quando si utilizza l'integrazione demo, è possibile utilizzare solo il metodo HTTP GET.

Leggere qui per ulteriori informazioni.

Altro

Self link

Tutte le risorse e tutte le collezioni hanno una proprietà “self” che contiene l'URL univoco che rappresenta esattamente quella risorsa o quella collezione. A volte la proprietà “self” di una collezione può contenere anche l’impaginazione, il filtro o l’ordinamento applicato.

Leggere qui per ulteriori informazioni.

Collezioni e risorse

La REST API è una API basata su un documento di tipo JSON, che consiste in una serie di risorse e collezione di risorse. Le collezioni prendono il nome dal tipo di risorsa che si trova nella collezione. Per esempio una collezione di clienti si chiama proprio: https://rest.reviso.com/customers

Ciascuna risorsa nella collezione conterrà il link a sé stessa, che sarà composto dal link alla collezione con l’identificativo della risorsa. Così il cliente n° 20 avrà il seguente link: https://rest.reviso.com/customers/20

Leggere qui per ulteriori informazioni.

Annotazione errori

N.B: Questa caratteristica è da poco uscita. Ancora non tutti gli endpoints l'hanno implementata.

Durante la creazione o la modifica dei dati attraverso la REST API sarà effettuata una validazione sui dati forniti prima che qualsiasi operazione di creazione/modifica sia eseguita. Se vi sono alcuni errori l’operazione non sarà accettata e restituirà un "400 Bad Request response", che tra le tante info vi fornirà anche i dettagli degli errori trovati.

Leggere qui per ulteriori informazioni.

Errori

Leggere qui per ulteriori informazioni.

Controllo delle versioni

Leggere qui per ulteriori informazioni.

Impaginazione

Leggere qui per ulteriori informazioni.

Filtri

Leggere qui per ulteriori informazioni.

Ordinamento

Leggere qui per ulteriori informazioni.

HTTP Status Codes

Leggere qui per ulteriori informazioni.

Endpoints

Le REST API sono in continua evoluzione per questo sono state suddivise in stabili e sperimentali.

Risorse stabili: sono risorse pronte pubblicate e ci si può fidare della firma. Potrebbero essere aggiunte altre proprietà o altri endpoints, ma non sarà mai modificata la loro struttura o rinominata una proprietà.

Risorse sperimentali: sono proprio questo, risorse sperimentali. Ma si è deciso di esporle pubblicamente in modo da poter avere un'idea di ciò che si sta costruendo. Potete provare gli endpoints sperimentali, ma si consiglia vivamente di non fare affidamento su queste risorse per implementare le proprie applicazioni o integrazioni. La loro firma è soggetta a modifiche e la denominazione delle proprietà potrebbe cambiare così, senza preavviso.
Quando le risorse sperimentali sono definitive vengono spostate nel gruppo delle risorse stabili, pronte per la produzione.



Leggi anche

Hai ricevuto la risposta alla tua domanda?