Erreurs

Abby utilise les codes HTTP pour indiquer le succès ou l'échec des requêtes envoyées à l'API. En cas d'échec, elle renvoie une erreur correspondant au code d'état approprié. Les codes d'état se répartissent en trois catégories :

• Les codes 2xx indiquent que la requête a réussi.

• Les codes 4xx signalent une erreur liée aux informations fournies.

• Les codes 5xx, plus rares, indiquent un problème côté serveur.

Attributs

En cas d'erreur, l'API renvoie un JSON décrivant les détails de l'erreur.

{
 "type": "api_error" | "authentication_error" | "rsc_error",
 "code": "internal_server_error" | "not_found" | ...
 "message": "Details de l'erreur"
 "param": "Le paramètre incorrect"
}

Code de status HTTP

200 - OK	Tout s'est correctement exécuté
201 - Created	La ressource a été correctement créée
400 - Bad Request	La requête contient de mauvais paramètres
401 - Unauthorized	La clé API n'est pas valide
403 - Forbidden	La clé API n'a pas l'accès requis
404 - Not Found	La ressource n'a pas été trouvée
429 - Too Many Requests	Trop de requêtes ont été envoyées à l'API
500, 502, 503 - Server Errors	Un problème est arrivé côté Abby

Types d'erreurs

api_error	Un problème est survenu côté API
authentication_error	La clé API n'est pas valide
rsc_error	La ressource ou les paramètres sont invalides

Codes d'erreur

internal_server_error	Une erreur est survenue sur l'API
token_failure	La clé API n'est pas valide
validation_error	Les paramètres de la requête sont incorrects
not_found	La ressource est introuvable
bad_request	Certains paramètres ne sont valides
forbidden	La clé API n'a pas les permissions requises