Introduccion
El objetivo de este documento es exponer a todos los interesados las opciones que ofrece el API de Cabal,. a traves de la tecnologia conocida com webservice. Detallar los servicios, parametros y requisitos para poder integrar los sistemas.
URLs
Entorno de pruebas
http://10.5.1.X:8080/sac (Wildfly 13)
Entorno de produccion
La direccion para produccion sera proporcionada por Cabal
Authentication User
Descripcion
Esta transaccion permite consultar la validez de un usuario en el SAC.
URI
| URI | Input Type | Output Type |
| /autheticationUser | POST, Content-Type: application/x-www-form-urlencoded | Content-Type:applicatoin/json |
|---|
Parametros de ingreso
| N° | Nombre | Tipo | Obligatorio? | Descripcion |
|---|
| 1 | user | varchar | Si |
|
| 2 | password | varchar | Si |
|
Parametros de egreso
| N° | Nombre | Tipo | Obligatorio? | Descripcion |
|---|
| 1 | SID | varchar | Si |
|
| 2 | exitCode | numeric | No |
|
| 3 | messageCode | varchar | No |
|
Authorization User
Descripcion
Esta transaccion permite obtener los datos de acceso del usuario, sus roles, plataformas, perfiles.
URI
| URI | Input Type | Output Type |
|---|
| *authorizationUser | POST, Conten-Type: application/x-www-form-urlencoded | Conten-Type:application/json |
Parametros de ingreso
| N° | Nombre | Tipo | Obligatorio? | Descripcion |
|---|
| 1 | SID | numeric | Si | Session ID |
Parametros de egreso
| N° | Nombre | Tipo | Obligatorio? | Descripcion |
|---|
| 1 | platforms | list | Si |
|
| 2 | roles | list |
|
|
| 3 | profiles | list |
|
|
| 4 | exitCode | numeric |
|
|
| 5 | messageCode | varchar |
|
|
Get Platform User
Descripcion
Esta transaccion permite obtener las plataformas a las que puede accedes un usuario
URI
| URI | Input Type | Output Type |
|---|
| /getPlatformsUser | POST, Conten-Type: application/x-www-form-urlencoded | Content-Type:application/json |
Parametros de ingreso
| N° | Nombre | Tipo | Obligatorio? | Descripcion |
|---|
| 1 | SID | numeric | Si | Session ID |
Parametros de egreso
| N° | Nombre | Tipo | Obligatorio? | Descripcion |
|---|
| 1 | platforms | list | Si |
|
| 2 | exitCode | numeric |
|
|
| 5 | messageCode | varchar |
|
|
Codigos de respuesta WS
| Codigo | Descripcion | Observacion |
|---|
| 0 | Resultado exitoso | Se obtiene del campo "exitCode". Si el codigo es cero, no hay mensaje de salida en la variable "messageCode" |
| -1 | Se ha producido un error | En el campo "messageCode" viene la descripcion del error |
