Errores¶
Afi utiliza códigos de estado de respuesta HTTP convencionales para indicar si una solicitud a la API se ha realizado correctamente o ha fallado. En general:
- Los códigos de estado del intervalo
2xxindican que la operación se ha realizado correctamente. - Los códigos de estado del intervalo
4xxindican un error relacionado con la información proporcionada y el estado actual (por ejemplo, se ha omitido un parámetro obligatorio o se ha enviado un valor no válido). - Los códigos de estado del intervalo
5xxindican un error en los servicios de Afi (estos errores son poco frecuentes).
Resumen de los códigos de estado HTTP:
| Código de estado HTTP | Descripción |
|---|---|
| 200 OK | La llamada se ha realizado correctamente. |
| 400 Bad Request | La solicitud ha fallado, a menudo debido a que falta un parámetro obligatorio, un parámetro no es válido o se dan ambas circunstancias. |
| 401 Unauthorized | No se ha proporcionado una clave de API válida. |
| 403 Forbidden | La clave de API no tiene permisos para realizar la solicitud. |
| 404 Not Found | El recurso solicitado no existe. |
| 429 Too Many Requests | Se han enviado demasiadas solicitudes a la API en poco tiempo. El cliente que realiza la solicitud debe aplicar retroceso exponencial antes de reintentarla. |
| 5xx - Internal Server Error | Se ha producido un problema en Afi (estos errores son poco frecuentes). La solicitud se puede volver a intentar con un retroceso exponencial. |
Tenga en cuenta que las solicitudes con códigos de estado 429 y 5xx se pueden volver a intentar con un retroceso exponencial.
Para facilitar la solución de problemas y el tratamiento automático de errores en la lógica de la aplicación, los errores incluyen un cuerpo JSON con los siguientes datos:
| Campo JSON del error | Descripción |
|---|---|
| status (entero) | Código de estado HTTP. |
| code (cadena) | Cadena de código de error que identifica de forma exclusiva el tipo de error notificado. |
| message (cadena) | Mensaje de error legible. |