Erreurs

Afi utilise les codes d’état de réponse HTTP conventionnels pour indiquer la réussite ou l’échec d’une requête API. En règle générale :

• Les codes d’état de la plage 2xx indiquent une réussite.
• Les codes d’état de la plage 4xx indiquent qu’une erreur s’est produite compte tenu des informations fournies et de l’état actuel (par exemple, un paramètre obligatoire a été omis ou une valeur non valide a été envoyée).
• Les codes d’état de la plage 5xx indiquent une erreur des services Afi (ces erreurs sont rares).

Récapitulatif des codes d’état HTTP :

Code d’état HTTP	Description
200 OK	L’appel a réussi.
400 Bad Request	La requête a échoué, souvent en raison d’un paramètre obligatoire manquant, d’un paramètre non valide ou des deux.
401 Unauthorized	Aucune clé API valide n’a été fournie.
403 Forbidden	La clé API ne dispose pas des autorisations nécessaires pour effectuer la requête.
404 Not Found	La ressource demandée n’existe pas.
429 Too Many Requests	Un trop grand nombre de requêtes a atteint l’API trop rapidement. L’appelant doit appliquer un délai exponentiel entre ses requêtes.
5xx - Internal Server Error	Une erreur s’est produite du côté d’Afi (ces erreurs sont rares). La requête peut être relancée avec un délai exponentiel.

Notez que les requêtes ayant reçu les codes d’état 429 et 5xx peuvent être relancées avec un délai exponentiel.

Afin de faciliter le dépannage et la gestion automatique des erreurs dans la logique applicative, les erreurs comprennent un corps JSON contenant les informations suivantes :

Champ JSON de l’erreur	Description
status (integer)	Code d’état HTTP.
code (string)	Chaîne de code d’erreur qui identifie de manière unique le type d’erreur signalé.
message (string)	Message d’erreur lisible par l’utilisateur.