Servicio de seguridad que permite a una terminal ser autorizada para utilizar el restos de los servicios del sistema. Este servicio requiere que se brinden las claves de acceso (un id y un secret), las cuales pueden obtenerse a través de la Consola de Administración en la sección "Clientes API" del módulo de seguridad. Retornará un token, el cual es requerido al invocar los servicios de negocio.
Es un método REST basado en el formato JSON. Ejemplo: [post] http://[dirección-ip]:[puerto]/api/v1/oauth2/authenticate |
|---|
POST - REQUESTBODY| Elemento | Descripción | Tipo de dato | Requerido |
|---|
clientId | Credenciales para el uso de la aplicación. Se obtienen de la consola, sección Seguridad > Clientes API. Identifica al usuario | String | Sí | clientSecret | Credenciales para el uso de la aplicación. Se obtienen de la consola, sección Seguridad > Clientes API Identifica a la contraseña del usuario. | String | Sí |
Ejemplo: {
"clientId":"vcn5keiiw0zf",
"clientSecret":"g23n2tlt3fmap0ymaosv"
}
|
RESPONSE OK| Elemento | Tipo | Detalle |
|---|
| token | String | Token de seguridad devuelto por el sistema. | | expiresIn | Number | Tiempo de expiración del token medido en unidad de expiración. | expUnit | String | Unidad de expiración. |
Ejemplo: {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNWU5NDczZGU4YTk2NDI5MzlkMzVkYzhiIn0sImlhdCI6MTU5NTk0NzkyOSwiZXhwIjoxNTk1OTUxNTI5fQ.yrMsmYgyPtii59moYgujKE96ZeFNhHuZnwt3OeE59fM",
"expiresIn": 3600000,
"expUnit": "miliseconds"
} |
RESPONSE ERROR| Elemento | Tipo | Detalle |
|---|
| ack | Number | Código de error. Siendo los valores posibles: | Requirement |
|---|
| freetext | Link |
|---|
| type | LINK |
|---|
| key | FF-2001 |
|---|
|
"Invalid credentials format": Verificar que se estén todos los datos obligatorios.
| Requirement |
|---|
| freetext | Link |
|---|
| type | LINK |
|---|
| key | FF-2002 |
|---|
|
"User not found": Verificar el valor del clientId provisto| Requirement |
|---|
| freetext | Link |
|---|
| type | LINK |
|---|
| key | FF-2003 |
|---|
|
"Invalid password": Verificar el valor del clientSecret provisto| Requirement |
|---|
| freetext | Link |
|---|
| type | LINK |
|---|
| key | FF-2999 |
|---|
|
"Internal Server Error"| Requirement |
|---|
| freetext | Link |
|---|
| type | LINK |
|---|
| key | FF-3999 |
|---|
|
"Internal Agent Error"
| | message | String | Detalle del tipo del error. |
Ejemplo: {
"ack": 2002,
"message": "User not found"
} |
|