Uso Basico
Documentación básica de uso de la API
Uso
La API esta construida siguiendo las principios REST, garantizando la seguridad, la integridad y la privacidad de los datos mediante HTTPS para todas las solicitudes.
URL base
https://qa.api.co.irdigital.pe/business-irdgco-logistic/v1/delivery/capacityEnviando solicitudes
Para enviar solicitudes a la API, necesitas autenticarte mediante uno de los siguientes mecanismos:
- JWT Bearer Token
- Basic Auth
Opción 1: JWT Bearer Token
Incluye el header Authorization con un token JWT válido:
Authorization: Bearer <jwt-token>Opción 2: Basic Auth
Incluye el header Authorization con las credenciales codificadas en Base64 (usuario:password):
Authorization: Basic <base64-usuario-password>Ejemplo de generación en consola:
echo -n "usuario:password" | base64Headers requeridos
| Header | Descripción |
|---|---|
| Authorization | Bearer JWT o Basic Auth |
| Content-Type | application/json |
Códigos de respuesta
La API usa códigos de respuesta HTTP para indicar el estado de las solicitudes. Estos códigos se pueden utilizar para identificar y manejar errores en la API.
| Código | Descripción |
|---|---|
200 | Successful request |
400 | Check that the parameters were correct |
401 | Credenciales ausentes o inválidas |
403 | Credenciales sin permisos |
404 | Resource not found |
429 | Rate limit exceeded |
5xx | Server errors |
Swagger
El archivo swagger de la API se puede consultar en el siguiente enlace: Swagger