/
Riferimento CLI & API
📘 Risorse generali API
Benvenuti nel riferimento API di Esadax. Qui troverai tutte le informazioni essenziali di cui hai bisogno per interagire con la nostra API, incluso come autenticarti, comprendere gli stati delle risposte e risolvere gli errori di convalida.
Autenticazione
Tutte le richieste API devono essere autenticate utilizzando un token API. Questo viene fatto aggiungendo un'intestazione Authorization alla tua richiesta HTTP.
✅ Formato di intestazione
Authorization: Bearer XXX
Sostituisci XXX con il token API effettivo.
Informazioni sui token API
- I token API vengono generati per account utente.
- Ogni token può avere permessi personalizzati per limitare l'accesso ad aree specifiche del tuo account.
- Ciò aiuta a mantenere l'integrazione sicura concedendo solo l'accesso necessario.
➡️ Per saperne di più sulla gestione dei token API
Risposta delle API
Esadax utilizza i principi RESTful e si conforma alle pratiche standard di risposta HTTP. Ogni risposta dall'API includerà un codice di stato HTTP pertinente per indicare il successo o l'insuccesso della tua richiesta.
📊 Codici di stato HTTP
| Codice | Nome | Descrizione |
|---|---|---|
| 200 | Va bene. | La richiesta è stata accettata con successo. |
| 201 pag. | Creato | La risorsa è stata creata con successo. |
| 202 pag. | Accettato | La richiesta è stata accettata e l'elaborazione continua in background. |
| 204 pag. | Non ci sono contenuti | La richiesta è stata accettata, ma non vi è alcun contenuto da restituire. |
| 400 | Richiesta non valida | Si è verificato un errore con la tua richiesta. Verificare i requisiti dell'endpoint e riprovare. |
| 401 pag. | Non autorizzato | Token API non valido. Per saperne di più. |
| 403 pag. | Vietato | L'azione non è consentita per questo token o account. Controllare le autorizzazioni del token. |
| 404 - Pagina non trovata | Articolo non trovato | Il sito web da lei richiesto è in manutenzione. |
| 405 pag. | Metodo non consentito | Il metodo HTTP utilizzato non è supportato per questo endpoint. |
| 408 pag. | Timeout di richiesta | C’è stato un timeout dalla nostra parte. Si prega di contattare il supporto. |
| 421 pag. | Servizio non disponibile | Il sito è attualmente in manutenzione. Riprovare più tardi. |
| 422 pag. | Entità non elaborabile | Errore di convalida nella tua richiesta. Rivedi e riprova. Per saperne di più |
| 429 pag. | Troppe richieste | Limite di velocità superato. Per saperne di più sui limiti di velocità |
| 500 | Errore interno del server | Errore server imprevisto. Si prega di contattare il supporto. |
| 502 pag. | Gateway non valido | Problema di sistema temporaneo. Si prega di contattare il supporto. |
| 503 pag. | Servizio non disponibile | Il sistema è attualmente non disponibile. Si prega di contattare il supporto. |
| 504 pag. | Gateway Timeout | C'è stato un timeout sul nostro sistema. Si prega di contattare il supporto. |
🔗 Ulteriori informazioni sui codici di stato HTTP sono disponibili su Mozilla Developer Network.
Errori di convalida
Gli errori di convalida (HTTP 422) si verificano quando il payload della richiesta non soddisfa i requisiti per un determinato endpoint. Ciò potrebbe essere dovuto a:
- Campi obbligatori mancanti
- Formati di dati non validi
- Parametri non corretti
Controlla sempre due volte la documentazione sull'endpoint API per assicurarti che il corpo della richiesta corrisponda al formato previsto.
