Información General

Las APIs están diseñadas para proporcionar una experiencia de integración segura, eficiente y estandarizada. En esta sección, encontrarás información clave sobre las cabeceras necesarias para realizar solicitudes, así como los errores más comunes y sus soluciones.

Es fundamental seguir estas especificaciones para garantizar una comunicación fluida y evitar problemas en la autenticación, trazabilidad y validación de las peticiones.

Cabeceras Comunes

Nuestras APIs requieren el uso de ciertas cabeceras estándar para asegurar la trazabilidad, seguridad y compatibilidad de las peticiones.

Cabecera	Descripción
Authorization	Cabecera utilizada para la autenticación. Debe incluir un access_token en formato Bearer Token.
trace-id	Identificador único de la solicitud para trazabilidad y depuración. Debe estar en formato UUID.
User-Agent	Identifica el cliente que realiza la solicitud. Debe tener el formato nombre-cliente

Ejemplo de uso en una petición HTTP:

GET /api/recurso HTTP/1.1
Host: api.ejemplo.com
Authorization: Bearer eyJhbGciOiJIUz...
trace-id: d6f5b8d2-6e35-4a3e-bf1e-d5fbb0b5a4c8
User-Agent: MiAplicacion/1.0 (Linux; Android 12)

Errores comunes

Nuestras APIs están estandarizadas para mejorar la experiencia y ser más transparentes en el proceso. A continuación, se detallan algunos errores comunes que pueden encontrarse:

StatusCode 401

401 - Realizar petición sin cabecera de authorization

{
    "error_code": "invalid_credentials",
    "message": "Invalid or missing credentials"
}

401 - Realizar petición con access_token expirado

{
    "error_code": "token_expired",
    "message": "The token provided already expired"
}

401 - Realizar petición con access_token invalido

{
    "error_code": "invalid_credentials",
    "message": "Invalid or missing credentials"
}

StatusCode 400

400 - Realizar petición sin trace-id

{
  "message": "The request performed is not supported.",
  "error_code": "invalid_request",
  "details": {
    "trace-id": "The header 'trace-id' is required"
  }
}

400 - Realizar petición con formato inválido de trace-id

{
  "message": "The request performed is not supported.",
  "error_code": "invalid_request",
  "details": {
    "trace-id": "The header 'trace-id' must be uuid format"
  }
}