Premiers pas

Erreurs

En cas de problème, l'API répond avec le statut HTTP correspondant et un corps contenant code et message dans error.

Utilisez code dans votre programme. message est un texte en anglais destiné à faciliter le débogage et peut changer.

Format de l'erreur404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

Sans clé401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

Codes d'erreur

Statut	Code	Quand cela se produit
400	`key_in_query`	La clé a été envoyée dans l'URL (paramètres `api_key`, `apikey`, `key` ou `token`). Envoyez-la dans l'en-tête et générez une nouvelle clé, car l'ancienne a pu être enregistrée dans des logs.
400	`invalid_parameter`	Un paramètre a une valeur invalide, par exemple `per_page` au-delà du maximum.
401	`missing_api_key`	La requête ne contient pas de clé.
401	`invalid_api_key`	La clé n'existe pas, a été révoquée ou son utilisateur est désactivé.
404	`not_found`	L'endpoint n'existe pas, ou l'élément n'existe pas ou appartient à une organisation que l'utilisateur ne peut pas voir.
404	`organization_not_found`	Le paramètre `organization` indiqué ne correspond à aucune organisation dans laquelle l'utilisateur peut voir ce type d'élément.
405	`method_not_allowed`	L'API n'accepte que `GET` (et `HEAD`).
429	`rate_limited`	La limite de requêtes a été atteinte. Attendez le nombre de secondes indiqué dans `Retry-After`.
500	`server_error`	Erreur interne. Réessayez dans quelques instants ; si le problème persiste, contactez le support.

Quand réessayer

Ne relancez la même requête qu'après une erreur 429 (en attendant le délai Retry-After) ou 500. Les autres erreurs nécessitent de corriger la requête ou la clé.