Erreurs

Dans ce guide, nous allons voir ce qu'il se passe lorsque quelque chose ne va pas avec votre appel API. Les erreurs arrivent et viennent très probablement de vous ! Regardons ensemble les erreurs types que vous pourrez rencontrer.

Vous pouvez déterminer si votre appel a réussi en vous appuyant sur le code de réponse de la requête HTTP. Si une requête a échoué, vous pouvez utiliser le code d'erreur pour savoir ce qu'il s'est mal passé et faire une chasse au bug avant de contacter le support.

Avant de contacter le support, veuillez noter que 99% des erreurs sont des erreurs liées à votre utilisation de l'API. Veuillez vous assurer que votre code fonctionne correctement avant de nous alerter d'un problème.

Codes de réponse HTTP

Voici la liste des différentes catégories de codes de réponse HTTP retournés par l'API. Utilisez-les pour déterminer si une requête a échoué ou non.

Name
2xx
Description
Un code de réponse 2xx indique que la requête a réuissi.
Name
4xx
Description
Un code de réponse 4xx indique que la requête a échoué pour une raison connue.
Name
5xx
Description
Un code de réponse 5xx indique une erreur du serveur API.

Types d'erreur

Lorsque une requête échoue, l'API retourne une réponse d'erreur composée d'un code d'erreur et d'un message. Vous pouvez utiliser ces informations pour mieux comprendre ce qu'il s'est mal passé et comment le résoudre.

Error response

{ 
"error": {
      "type": "missingParameters",
      "message": "Un ou plusieurs paramètres requis sont manquants.",
      "details": "Make sure that all the body parameters are present and correctly formatted",
      "status": 400,
      "help": "See reference & general behavior of this API at https://doc.shunter.fr",
      "parameters": [{
            "code": "invalid_type",
            "expected": "string",
            "received": "number",
            "path": ["name"],
            "message": "Required"
        }]
    }
}