Erreurs API : codes de réponse et request_id
En cas de refus de l'API, NN Agent renvoie un JSON avec une description de l'erreur et l'identifiant de la requête.
{
"error": { "code": "unauthorized", "message": "Missing bearer token" },
"request_id": "f04e847d-8505-4b7b-a5c8-7aee42a8fc55"
}Champ request_id#
request_id — identifiant unique d'un appel spécifique. Enregistrez-le de votre côté : le support l'utilise pour retrouver la demande dans les journaux, sans avoir à redemander l'heure, le corps et les en-têtes. Sans lui, l'analyse d'un appel échoué se transforme en échanges pendant une journée.
Codes de réponse#
| Code | Quand cela se produit | Que faire |
|---|---|---|
200 |
Requête exécutée | — |
401 |
L'en-tête Authorization est manquant ou le jeton est invalide ou a expiré |
Vérifiez l'authentification |
404 |
L'adresse n'existe pas. Le format de la réponse est différent : {"detail":"Not Found"} |
Vérifiez le chemin et la version avec le guide |
422 |
Le corps ou les paramètres n'ont pas passé la validation | Voir detail — il y a une liste des champs et des raisons pour lesquelles ils ont été rejetés |
Formulaire d'erreur de validation#
La réponse 422 contient une liste des champs problématiques : pour chacun, l'emplacement dans la requête (loc), le message (msg) et le type d'erreur (type).
{
"detail": [
{ "loc": ["body", "field_name"], "msg": "field required", "type": "value_error.missing" }
]
}Erreur de certificat — pas d'erreur API#
Si le client interrompt la connexion lors de la vérification du certificat TLS, il n'y a pas de réponse de l'API : api.nexifyneo.com renvoie un certificat auto-signé. Ce type d'échec n'a ni code, ni request_id, et il est inutile de le chercher dans les journaux de l'API. Détails — Limitations connues.
Suite#
- Authentification — comment transmettre le jeton.
- Aperçu de l'API — composition des opérations et différences entre les versions.