Aller au contenu

Erreurs

Quand une requête échoue, l'API répond avec un statut HTTP d'erreur et un corps en application/problem+json, le format de la RFC 9457.

Le format

Chaque erreur porte ces champs :

type
L'adresse de la page qui documente l'erreur.
title
Le résumé de l'erreur, en français, toujours le même pour un code.
status
Le statut HTTP de la réponse.
detail
L'explication de cette occurrence, en français. Elle ne cite jamais une donnée personnelle, pas même l'entrée.
instance
L'identifiant de cette occurrence, tiré de l'en-tête X-Request-ID de la réponse. Absent de l'erreur d'un élément d'un lot.
code
L'identifiant stable de l'erreur.

Gérer une erreur

  • Décide d'après code : title et detail sont des textes faits pour être lus.
  • La liste des codes est ouverte : un code que tu ne connais pas encore peut apparaître. Traite-le d'après status.
  • Quand tu signales un problème, cite instance.

Les erreurs

StatutCodeTitre
400invalid_bodyCorps de requête invalide
400invalid_parameterParamètre invalide
400missing_parameterParamètre manquant
401invalid_api_keyClé API invalide
401missing_api_keyClé API manquante
403challenge_failedVérification anti-abus échouée
404not_foundRessource introuvable
405method_not_allowedMéthode non autorisée
413content_too_largeCorps de requête trop gros
415unsupported_media_typeType de contenu non pris en charge
422invalid_inputEntrée invalide
422invalid_login_linkLien de connexion invalide
422too_many_itemsTrop d'éléments
429too_many_requestsTrop de requêtes
500internal_errorErreur interne
503authentication_unavailableAuthentification indisponible
503challenge_unavailableVérification anti-abus indisponible
503key_request_unavailableDemande de clé indisponible
503service_unavailableService indisponible