Códigos de error de la API

Códigos de respuesta HTTP

• Los códigos de respuesta 2 XX indican una solicitud correctamente procesada (por ejemplo, el código 200 para recuperar datos, el código 201 para agregar una nueva entidad, el código 204 para una eliminación correcta, etc.)

• Los códigos de respuesta 4 XX indican que una solicitud no se pudo procesar correctamente debido a algunos problemas con los datos del cliente (por ejemplo, 404 al dirigirse a un recurso inexistente).

• Los códigos de respuesta 5 XX indican que se ha producido un error del lado del SI durante el procesamiento de la solicitud (por ejemplo, cuando una BD no está disponible temporalmente).

Cuerpo de la respuesta con errores

Cada error de respuesta incluye el código HTTP y los datos JSON con la descripción del error. Tiene la siguiente estructura:

• error_code – número del código de error;

• error_message– texto con la descripción del error;

• details – detalles adicionales del error (el formato se especifica para cada caso). Puede estar vacío.

Ejemplo de respuesta de error:

{
    "error_code": 0,
    "error_message": "Se ha producido un error desconocido del lado del servidor",
    "details": null
}

Códigos de error:

• 0 – UNKNOWN Error de servidor desconocido.

• 1 - NOT ALLOWED Se llamó un método no permitido. Por lo general, le sigue el estado de respuesta HTTP 405. Por ejemplo, al intentar solicitar el método PATCH, cuando sólo se admiten los métodos GET/POST.

• 2 - NOT REALIZED El método está documentado pero no realizado, por ninguna razón temporal o permanente.

• 3 - INVALID STRUCTURE Estructura incorrecta de la solicitud. Faltan algunos campos obligatorios o se ha producido un error de validación de formato.

• 4 - INVALID VALUE Valor incorrecto del parámetro dentro del cuerpo de la solicitud o de la consulta.

• 5 - INVALID TYPE Tipo de datos no válido del parámetro de la solicitud.

• 6 - AUTH NOT PROVIDED No se especificó el token de acceso.

• 7 - AUTH INVALID El token de acceso no existe en la base de datos.

• 8 - AUTH EXPIRED El token de autentificación caducó.

• 9 - AUTH FORBIDDEN Acceso denegado para el usuario actual.

• 10 - NOT EXIST No se encuentra el recurso solicitado (alternativa de HTTP status_code = 404).

• 11 - EXTERNAL SERVICE Error en el sistema de información externo.

• 12 – DATABASE Error crítico de la base de datos en el servidor.