Informazioni generali
Le API sono esposte dal seguente endpoint:
SANDBOX | https://sandbox.cloudfinance.it/api/v1/ |
PRODUZIONE FreeInvoice | https://webapp.freeinvoice.it/api/v1/ |
PRODUZIONE BPilot | https://webaccounting.cloudfinance.it/ |
NB: Tutte le chiamate devono essere effettuate utilizzando il protocollo HTTPS. Non è possibile invocare le API utilizzando HTTP.
Nello specifico, tutte le chiamate avranno la seguente forma:
- METHOD https://endpoint/api/v1/comando
Dove comando definisce l’operazione che si vuole effettuare. Tutte le risposte restituiranno codice http 200 e saranno in formato JSON.
In caso di errore nella gestione della richiesta la risposta avrà la seguente forma:
{
"errors": [
{
"code": "001", // Identifica l'errore
"message": "Api Key non valida", // Descrive l'errore
}
// Altri errori
]
}
Si noti che gli errori potrebbero essere più di uno.
Le API permettono di eseguire le seguenti operazioni:
- Inviare una fattura non firmata (la fattura sarà firmata dal nostro sistema);
- Inviare una fattura già firmata dal cliente;
- Elencare le fatture inviate;
- Elencare le fatture ricevute;
- Elencare le notifiche ricevute;
- Visualizzare i dettagli di una fattura;
- Visualizzare i dettagli di una notifica.