Este servicio permite consultar un JWT (Json Web Token) para poder consultar los métodos seguros de Bridge Api.
- Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/auth/login - Ejemplo: https://localhost:8090/auth/login
- Se invoca via POST.
- En el cuerpo se debe enviar
- clientId
- clientSecret
Nota
Ejemplo de request con CURL:
curl --location --request POST 'http://localhost:8090/auth/login' \ --header 'Content-Type: application/json' \ --data-raw '{ "clientId":"bridge-api-client", "clientSecret":"DA39A3EE5E6B4B0D3255BFEF95601890AFD80709" }'
Descripción de los campos:
Campo | Tipo | Descripción | Requerido | Ejemplos |
clientId | String | Identificaro único del usuario que quiere acceder al servicio | SI | bridge-api |
clientSecret | String | Valor alfanumerico asociado al ClientId | SI |
|
Respuesta del servicio:
{ "ack": 0, "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEifQ.eyJpZCI6IjVlYjQzODgzNzYwNjM2MDNmOGFhOWM3MCIsImlhdCI6MTU5MzUzMTUxNywiZXhwIjoxNTkzNzA0MzE3LCJhdWQiOiJteWF1ZCIsImlzcyI6Im15aXNzdWVyIiwic3ViIjoiY2xpZW50IiwianRpIjoiMSJ9.ghrJlsem6HRo1X_nKfN85NPqy3duRsA5_l8Peiqm5HU", }
- ack es el código de respuesta, en caso de ser un error, mirar tabla a continuación.
- token es el token asignado a ese usuario.
Con el token ahora se puede acceder a los metodos protegidos de Bridge Api
Enviar el token en un servicio:
Una vez que se obtuvo el token, este se debe enviar en el HEADER de para ser evaluado por el servicio.
- Se envía de la siguiente manera: https://[direccion_ip]:[puerto]/auth/me - Ejemplo: https://localhost:8090/auth/me
- Se invoca via POST.
- El token se debe enviar en el header (cabecera) con el nombre x-access-token
Nota
El método /auth/me sirve para probar si el token es valido
Ejemplo de request con CURL
Ejemplo curl --location --request POST 'http://localhost:8090/auth/me' \ --header 'x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEifQ.eyJpZCI6IjVlYjQzODgzNzYwNjM2MDNmOGFhOWM3MCIsImlhdCI6MTU5MzUzMTUxNywiZXhwIjoxNTkzNzA0MzE3LCJhdWQiOiJteWF1ZCIsImlzcyI6Im15aXNzdWVyIiwic3ViIjoiY2xpZW50IiwianRpIjoiMSJ9.ghrJlsem6HRo1X_nKfN85NPqy3duRsA5_l8Peiqm5HU' \ --data-raw '' |
Códigos de error generales:
Código de Error | Descripción |
0 | La operación es exitosa. |
899 | Error al autentificarse. ClientId o ClienteSecret no son correctos. |
898 | Error desconocido solicitando el Token. Puede ser que el token enviado este mal formado. |
897 | Token expirado |
896 | x-access-token es vacío o no se envió en el header. |
999 | Error desconocido |