Errores
La forma de respuesta de error, los códigos de estado y cómo manejarlos.
Cuando falla una solicitud, API devuelve un cuerpo JSON con un campo error que describe lo que salió mal. Incorporar esto en su integración desde el principio hace que las fallas sean fáciles de registrar y actuar.
Forma de error
La mayoría de los errores se ven así:
{ "error": "Project not found." }Los errores de validación utilizan un valor error fijo y agregan una matriz details que describe cada problema, para que pueda mostrar comentarios a nivel de campo:
{
"error": "ValidationError",
"details": [{ "path": ["dueDate"], "message": "Invalid date" }]
}Códigos de estado
| Estado | Significado | Qué hacer |
|---|---|---|
| 400 | Entrada, parámetro de ruta o parámetro de consulta no válidos | Arreglar la solicitud; verifique details para ver el campo defectuoso |
| 401 | Token de portador faltante o no válido | Volver a autenticar o actualizar el token de acceso |
| 402 | No hay suficientes créditos para una operación sujeta a crédito | Agregue créditos y vuelva a intentarlo (consulte Credits) |
| 403 | Autenticado pero no permitido en el ámbito o espacio de trabajo seleccionado | Verifique el contexto del espacio de trabajo y los permisos de la persona que llama |
| 404 | No se encontró el registro o referencia solicitado | Verifique el ID, alias o referencia |
| 409 | Conflicto, como una transición de estado no válida o una restricción duplicada | Conciliar el estado antes de volver a intentarlo |
| 429 | Tarifa limitada (más a menudo en la creación de OTP) | Retrocede y vuelve a intentarlo más tarde |
| 500 | Error inesperado del servidor | Reintentar con retroceso; informar si persiste |
| 502 | Un servicio ascendente devolvió una respuesta no válida o fallida | Reintentar con retroceso |
Reintentar la guía
Vuelva a intentar solo las respuestas 429 y 5xx transitorias, y utilice siempre un retroceso exponencial. No vuelva a intentar errores 4xx como 400, 401, 403, 404 o 409 sin cambiar primero la solicitud; volverán a fracasar de la misma manera.