Manual de usuario: Autenticación en el API de Proveedores
Este documento describe el proceso paso a paso para autenticarse en el API de proveedores de LRP. La autenticación consta de dos etapas:
Autenticación en el Controlador Auth para obtener el primer token de autorización.
Autenticación en el Controlador correspondiente para obtener un segundo token de sesión.
1. Autenticación en el controlador Auth
Para obtener el primer token, es necesario autenticarse en el Controlador Auth en el endpoint Token
.
Endpoint:
POST /Token
Parámetros requeridos:
Usuario: asignado por el área de tecnología de LRP.
Contraseña: asignada por el el área de tecnología de LRP.
Respuesta esperada:
Si las credenciales son correctas, el endpoint responderá con un token de acceso. Este token debe ser copiado y almacenado para usarlo en el siguiente paso de este manual. Tiene una vigencia de 30 minutos.
Ejemplo de respuesta:
{
"token": "eyJhbGciOiJIUzI1NiIsIn..."
}
2. Autenticación en el API de Integración
Después de obtener el primer token, el siguiente paso es autenticarse en el controlador específico al que se desea integrar:
Customs (Aduana)
International (Internacional)
Land (Terrestre)
Cada uno de estos controladores tiene un endpoint de autenticación que requiere la siguiente información:
Endpoint:
POST /api/{NombreControlador}/Authentication
Parámetros requeridos:
{
"User": "string",
"Password": "string",
"Lrp": 0
}
User: Usuario integrador de LRP.
Password: Contraseña correspondiente al usuario.
Lrp: Código del LRP, que se puede obtener en la siguiente URL:
Encabezado de autorización:
El token obtenido en el paso anterior debe ser enviado en el encabezado Authorization
, precedido por la palabra Bearer.
Ejemplo de encabezado:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...
Respuesta esperada:
Si las credenciales y el token son válidos, el controlador responderá con un segundo token.
Ejemplo de respuesta:
{
"token": "eyJhbGciOiJIUzI1NiIsIn..."
}
3. Uso de los Tokens para consultas en el API
Con los dos tokens generados, ahora se pueden realizar consultas a los diferentes endpoint del API correspondiente. Es importante incluir siempre el segundo token en el encabezado de autorización para cada solicitud.
Ejemplo de solicitud a un endpoint protegido:
GET /api/{NombreControlador}/Datos
Parámetro de Token:
security.token: eyJhbGciOiJIUzI1NiIsIn...
Encabezado de autorización:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...
Conclusión
Este proceso de doble autenticación garantiza la seguridad en la integración con el API de proveedores de LRP. Es fundamental recordar que el primer token expira en 30 minutos, por lo que se recomienda utilizarlo inmediatamente para obtener el segundo token y realizar las consultas necesarias.