Réponse de l’API

Lorsque l’API renvoie sa réponse et que celle-ci s’est bien déroulée, vous trouverez plusieurs éléments récurrents :

• success qui aura sa valeur à true
• statusCode qui aura sa valeur à 200
• code qui aura sa valeur à ok
• data qui contiendra les informations de la réponse

Exemple d’une réponse correcte de l’API :

{
    "success": true,
    "statusCode": 200,
    "code": "ok",
    "data": {
        [...]
    }
}

IMPORTANT
Certains endpoints peuvent renvoyer un statut HTTP 200, car la requête s’est bien déroulée, alors qu’aucun contenu n’a été trouvé.

Il est recommandé de tester que le statut HTTP est égal à 200 ET que code (dans la réponse) est à ok.

Réponse du endpoint de récupération des données d’un pays lorsqu’un code pays n’est pas reconnu :

{
    "success": true,
    "statusCode": 200,
    "code": "no_country_found",
    "message": "No country found"
}

Erreurs

Si votre requête auprès de l’API échoue, celle-ci renverra une réponse contenant un statusCode, un code et un message indiquant le type d’erreur rencontrée (et la valeur de success, quand à elle, passera à false).

Exemple de réponse lorsqu’une erreur est rencontrée par l’API :

{
    "success": false,
    "statusCode": 429,
    "code": "quota_exceeded",
    "message": "Quota exceeded for this API key"
}

Codes et messages d’erreur

Les endpoints ont des messages d’erreurs qui leurs sont propres mais il existe d’autres codes et messages globaux :

StatusCode	Code	Description
429	quota_exceeded	« Quota exceeded for this API key » S’affiche lorsque le quota mensuel a été dépassé.
404	not_found	« The requested resource does not exist » Le endpoint n’existe pas.
403	invalid_api_key	« API key is invalid or missing to access to the requested resource » La clé API envoyée avec la requête est non valide ou bien manquante. En savoir plus sur l’authentification
500	internal_error	« An internal error occurred » Une erreur est survenue du côté de l’API. N’hésitez pas à nous contacter si le problème persiste.