Erreurs
Toutes les erreurs renvoient le code de réponse HTTP le plus spécifique et le plus approprié du tableau suivant :
Codes de retour
Code | Erreur | Description |
---|---|---|
400 | Mauvaise demande | Une requête malformée a été reçue du client. Il s'agit de la réponse la plus générique donnée par l'API |
401 | Non autorisé | Vous n'êtes pas autorisé et ne pouvez pas accéder à la ressource demandée |
403 | Interdit | Vous n'avez pas l'autorisation d'accéder à la ressource demandée |
404 | Non trouvé | La ressource demandée est introuvable. Elle sera peut-être disponible ultérieurement |
405 | Méthode non autorisée | Une méthode HTTP non prise en charge a été utilisée pour la ressource demandée. |
406 | Inacceptable | Le type Accept ou Accept-Encoding demandé par le client n'est pas disponible. |
409 | Conflit | La demande ne peut pas être traitée en raison d'un conflit avec la ressource existante. |
410 | Disparu | La ressource demandée n'est plus disponible et ne le sera jamais à l'avenir. |
411 | Longueur requise | La ressource demandée s'attend à ce que le client fournisse une longueur de contenu (Content-Length). |
413 | Entité de la demande trop grande | Le corps de la requête fourni par le client est trop volumineux, la ressource refuse de le traiter |
415 | Type de support non pris en charge | Un type de contenu incorrect (ou inexistant) a été fourni par le client. |
422 | Entité non traitable | La demande n'est pas malformée et le type de média est acceptable, mais la ressource ne peut pas traiter la demande. |
429 | Trop de demandes | La limite de taux a été atteinte. Pour plus d'informations, voir la section Limitation du débit |
500 | Erreur de serveur interne | Le serveur n'a pas pu traiter votre demande en raison d'une erreur interne inattendue. |
501 | Non mise en œuvre | La ressource demandée n'a pas été mise en œuvre |
503 | Service indisponible | Le service demandé est temporairement indisponible |
Format de réponse standard
Toutes les erreurs auront un corps de réponse standard avec deux champs, code et message. D'autres champs peuvent être utilisés, mais ils sont facultatifs.
Exemples
Il s'agit de la forme la plus simple du corps de retour d'une erreur. Les clients peuvent compter sur la présence de ces champs dans chaque erreur.
Réponses aux erreurs - Exemple 1 (ligne de base)
{
"code": 429,
"message": "You have exceeded your number of requests. Please try again later"
}
L'exemple suivant contient, en plus des champs standard, les erreurs associées à cette demande spécifique.
Réponses aux erreurs - Exemple 2 (plus complexe)
{
"code": 422,
"message": "Unprocessable entity",
"cause": "Validation failed",
"errors": [
{
"resource": "Issue",
"field": "title",
"code": "missing_field"
},
...
]
}