Patrones de Respuesta

Visión General

Esta documentación describe los posibles códigos de error que pueden ser devueltos por la API al manejar solicitudes.

Códigos de Éxito

200 - OK

Descripción: Indica que la solicitud se ha completado con éxito y el servidor ha devuelto los datos solicitados.

204 - No Content

Descripción: Indica que la solicitud se ha completado con éxito y el cliente no necesita salir de la página actual.

Códigos de Error

400 - Bad Request

Descripción: Este código de error indica que el servidor no puede o no procesará la solicitud debido a algo que se percibe como un error del cliente, como una sintaxis de solicitud mal formada, un formato de mensaje de solicitud inválido o un enrutamiento engañoso de la solicitud.

Respuesta de Ejemplo:

{
  "error": "Bad Request",
  "message": "Faltan los parámetros obligatorios 'param1' y 'param2'.",
  "code": 400
}

401 - Unauthorized

Descripción: Este código de error indica que la solicitud no se aplicó porque carece de credenciales de autenticación válidas para el recurso de destino.

Respuesta de ejemplo:

{
  "error": "Unauthorized",
  "message": "Credenciales inválidas. Se requiere autenticación para acceder a los recursos.",
  "code": 401
}

404 - Not Found

Descripción: Este código de error indica que el servidor de origen no encontró una representación actual para el recurso de destino o no está dispuesto a revelar que existe. Un código de estado 404 no indica si esta falta de representación es temporal o permanente.

Respuesta de ejemplo:

{
  "error": "Not Found",
  "message": "No se pudo encontrar el recurso solicitado.",
  "code": 404
}

500 - Internal Server Error

Descripción: Indica que ocurrió un error inesperado en el servidor al procesar la solicitud.

Respuesta de ejemplo:

{
  "error": "Internal Server Error",
  "message": "El servidor encontró un error inesperado mientras procesaba la solicitud.",
  "code": 500
}