Conceptos base

A tener en cuenta

Para realizar peticiones a la API de Idukay, es necesario contar con un token de acceso, el cual se obtiene a través del panel de administración de Idukay. Si no cuentas con un token de acceso, por favor contacta a tu administrador de Idukay.

Cabeceras (Headers)

Cada solicitud a la API debe incluir los siguientes encabezados:

Key	Descripción	Value
Authorization	Utiliza el encabezado Authorization con el valor Bearer <token> para autenticar tus solicitudes (requerido).	Bearer <token>
Content-Type	Especifica el tipo de contenido del cuerpo de la solicitud agregando el encabezado Content-Type con el valor application/json (requerido).	application/json
type	Se utiliza para especificar el origen de la petición, el valor debe ser API para las peticiones realizadas desde la API (requerido).	API

Respuestas de la API

La API de Idukay responde a las solicitudes con un objeto JSON que contiene los datos solicitados. La estructura de la respuesta es la siguiente:

✅ Solicitud exitosa

GET /api/users HTTP/1.1

{
  "response": [
    {
      "_id": "60bc56500000000000000000",
      "name": "John Doe",
      "email": "john.doe@mail.com",
    },
    {
      "_id": "60bc56500000000000000001",
      "name": "Peter Parker",
      "email": "peter.parker@mail.com",
    }
  ],
  "errors": []
}

❌ Solicitud fallida

POST /api/users HTTP/1.1

{
  "response": [],
  "errors": [
    {
      "message": "no_permissions",
      "value": "create"
    }
  ]
}

Propiedades de la respuesta

• response: Contiene los datos solicitados en la respuesta, en gran parte va a ser un array de objetos JSON.
• errors: Contiene los errores que se hayan producido durante la solicitud.

Códigos de estado HTTP

La API devuelve códigos de estado HTTP para indicar el resultado de una solicitud. En caso que surga algún error, la API devolverá un código de estado HTTP 200 con un objeto JSON que contiene los errores producidos.

A continuación se ofrecen algunas pautas para interpretar los códigos de estado:

Código	Descripción	Resultado
200	La solicitud se ha completado con éxito.	{ "response": [ { "_id": "60bc56500000000000000000", "name": "John Doe" } ], "errors": [] }
200	Hubo un error en la solicitud.	{ "response": [], "errors": [ { "message": "no_permissions", "value": "create" } ] }
403	La solicitud no se pudo procesar debido a un error de autorización.	{ "response": [], "errors": [ { "message": "unauthorized", "value": "token" } ] }
404	El recurso solicitado no se pudo encontrar.	404 Not Found
504	Esto indica que el servidor no pudo responder a la solicitud en el tiempo asignado. Debes intentar nuevamente más tarde.	504 Service Unavailable