Documentazione
Consulta la documentazione generale sull'integrazione con le nostre applicazioni e le pagine specifiche relative alle API.
Errori
Le nostre API usano i codici di stato HTTP per comunicare l'esito di una richiesta.
I codici di stato possono generalmente essere divisi in tre categorie:
- 2xx la richiesta è stata eseguita con successo
- 4xx indica che il contenuto della richiesta del client contiene uno o più errori
- 5xx si è verificato un errore interno al server
Quando una richiesta non va a buon fine, il contenuto della risposta riporta, se appropriato, informazioni sul campo o sull'oggetto in cui si è verificato l'errore.
Di seguito sono elencati i codici di stato di errore che possono essere generati dalle noste API:
| Codice | Significato |
|---|---|
| 400 | Il contenuto della richiesta contiene valori che non possono essere accettati perchè non validi oppure non sono state rispettate una o più regole di business. |
| 401 | Il token di accesso alla risorsa non è disponibile, non è valido oppure è scaduto. Per risolvere questo problema, dovresti rieseguire la procedura di autenticazione. |
| 404 | La risorsa richiesta non esiste. |
| 429 | La tua applicazione sta facendo troppe richieste ed è stato superato il limite imposto. Per risolvere il problema, dovresti aspettare il numero di secondi indicati nel record di intestazione HTTP Retry-After prima di effettuare un nuovo tentativo. |
| 500 | Il nostro server è in una situazione di errore non recuperabile. In questo caso, ti preghiamo di contattarci. |
| 503 | E' in corso una manutenzione che impedisce l'accesso ai servizi API. Questo problema è generalmente temporaneo e gli interventi di manutenzione (inizio e fine) sono generalmente comunicati con largo anticipo. |
Esempio
Per ottenere l'elenco degli articoli in un archivio è obbligatorio fornire l'identificativo dell'archivio. In questa richiesta viene fornito un identificativo di archivio che non esiste:
GET /efat/api/v1/articoli/1007/88473
La risposta sarà:
HTTP/2 400
cache-control: no-cache
pragma: no-cache
content-length: 84
content-type: application/json; charset=utf-8
expires: -1
date: Fri, 11 Mar 2022 08:26:37 GMT
[
{
"errorCode": "HTTP400",
"message": "Identificativo archivio non valido",
"path": "Id"
}
]