Erreurs

Afi utilise les codes d’état HTTP standard 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 signalent une erreur liée aux informations fournies et à 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 signalent une erreur du côté 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	L’API a reçu trop de requêtes en peu de temps. L’appelant doit appliquer une stratégie d’attente exponentielle avant de réessayer.
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 en appliquant une stratégie d’attente exponentielle.

Notez que les requêtes ayant reçu les codes d’état 429 et 5xx peuvent être relancées en appliquant une stratégie d’attente exponentielle.

Pour faciliter la résolution des problèmes et permettre à l’application de gérer automatiquement les erreurs, les réponses d’erreur contiennent un corps JSON avec les informations suivantes :

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