Errors

Cette page détaille comment interpréter les erreurs

L'API Engagement utilise des codes de réponse HTTP conventionnels pour indiquer le succès ou l'échec d'une requête API. En général :

• Les codes de la plage 2xx indiquent un succès.

• Les codes de la plage 5xx indiquent une erreur au niveau des serveurs de l'API Engagement (ces erreurs sont rares).

• Les codes de la plage 4xx indiquent une erreur due aux informations fournies (par exemple, un paramètre requis est manquant).

​Attributes

Name	Type	Description
ok	boolean	La requête retourne un booléen du statut de la requête (true/false)
message	string	Un message compréhensible fournissant plus de détails sur l'erreur.
code	string	Le code de l'erreur

​Exemple

{
    "ok": false,
    "code": "INVALID_QUERY",
    "message": {
        "issues": [
            {
                "code": "invalid_type",
                "expected": "number",
                "received": "nan",
                "path": [
                    "limit"
                ],
                "message": "Expected number, received nan"
            }
        ],
        "name": "ZodError"
    }
}