Como podemos ayudarte?
Login
Descripción
Permite a los usuarios autenticarse y obtener el token de acceso para realizar consultas a la CustomerAPI.
A continuación se explica cómo autentificarse utilizando Postman.
Los pasos a seguir son:
- Obtener credenciales en PlataformaGV
- Obtener token en Postman
- Ingresar token en consultas de Postman
1. Obtener credenciales en Plataforma GV
- Se debe ingresar a la plataforma de GeoVictoria e ir a Configuraciones > Acceso API.
- Copiar las credenciales Clave API y Secreto. Estas serán utilizadas en el request en Postman.
2. Obtener token en Postman
Una vez obtenidas las credenciales en la plataforma, se deben ingresar a Postman para realizar una consulta que retorne el token.
La consulta se verá de esta forma:
Request
Request Body
| Campos | Requerido | Tipo de dato | Descripción |
|---|---|---|---|
| User | Sí | String | Clave API que se obtiene de plataforma > Configuraciones > Acceso API |
| Password | Sí | String | Secreto que se obtiene de plataforma > Configuraciones > Acceso API |
{
"User": "aa1bb2",
"Password": "cc33dd44"
} Response
Response Body
| Campos | String | Descripción |
|---|---|---|
| token | String | JSON Web Token (JWT) generado tras la autenticación exitosa del usuario |
Códigos
| Código | Descripción |
|---|---|
| 200 | Éxito |
| 400 | Error en el request |
| 500 | Error no controlado, contactar a GV |
{
"token": "ee5ff6gg7hh8ii9jj10kk..."
}
3. Ingresar token en consultas de Postman
Una vez obtenido el token, para realizar consultas a la CustomerAPI se debe seleccionar Auth, seleccionar Bearer Token en Auth Type y agregar el token en el campo Token.
¡Listo!
Ya puedes hacer consultas a la CustomerAPI