Errores de API: códigos de respuesta y request_id
Cuando el API NN Agent falla, devuelve un JSON con la descripción del error y el identificador de la solicitud.
{
"error": { "code": "unauthorized", "message": "Missing bearer token" },
"request_id": "f04e847d-8505-4b7b-a5c8-7aee42a8fc55"
}Campo request_id#
request_id — identificador único de una llamada específica. Regístrelo en su lado: con él, el soporte encuentra la solicitud en los registros, sin preguntar nuevamente por la hora, el cuerpo y los encabezados. Sin él, el análisis de una llamada fallida se convierte en una correspondencia de un día.
Códigos de respuesta#
| Código | Cuándo ocurre | Qué hacer |
|---|---|---|
200 |
Solicitud completada | — |
401 |
El encabezado Authorization está ausente o el token es inválido o ha expirado |
Verifique la autenticación |
404 |
La dirección no existe. La forma de respuesta es diferente: {"detail":"Not Found"} |
Verifique la ruta y la versión con el manual |
422 |
El cuerpo o los parámetros no pasaron la validación | Consulte detail — allí se enumera qué campo y por qué fue rechazado |
Formulario de error de validación#
La respuesta 422 contiene una lista de campos problemáticos: para cada uno se indica la ubicación en la solicitud (loc), el mensaje (msg) y el tipo de error (type).
{
"detail": [
{ "loc": ["body", "field_name"], "msg": "field required", "type": "value_error.missing" }
]
}Error de certificado — no es un error de API#
Si el cliente interrumpe la conexión durante la verificación del certificado TLS, no hay respuesta de la API en absoluto: api.nexifyneo.com devuelve un certificado autofirmado. Tal fallo no tiene ni código, ni request_id, y buscarlo en los registros de la API es inútil. Detalles — Limitaciones conocidas.
Siguiente#
- Autenticación — cómo transmitir el token.
- Resumen de la API — conjunto de operaciones y diferencias entre versiones.