API WS

Introducción

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.

Entorno de pruebas

http://10.5.1.X:8080/sac (Wildfly 13)

Entorno de producción

La dirección para producción será proporcionada por Cabal

Descripción

Esta transacción permite consultar la validez de un usuario en el SAC.

URI

URI	Input Type	Output Type
/authenticationUser	POST, Content-Type:application/x-www-form-urlencoded	Content-Type:application/json

Parámetros de ingreso

N°	Nombre	Tipo	Obligatorio?	Descripción
1	user	varchar	Si
2	password	varchar	Si

Parámetros de egreso

N°	Nombre	Tipo	Obligatorio?
1	SID	varchar	Si
2	exitCode	numeric	No
3	messageCode	varchar	No

Descripción

Esta transacción 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

Parámetros de ingreso

N°	Nombre	Tipo	Obligatorio?	Descripción
1	SID	numeric	Si	Session ID

Parámetros de egreso

N°	Nombre	Tipo	Obligatorio?
1	platforms	list	Si
2	roles	list
3	profiles	list
4	exitCode	numeric
5	messageCode	varchar

Descripción

Esta transacción 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

Parámetros de ingreso

N°	Nombre	Tipo	Obligatorio?	Descripción
1	SID	numeric	Si	Session ID

Parámetros de egreso

N°	Nombre	Tipo	Obligatorio?
1	platforms	list	Si
2	exitCode	numeric
5	messageCode	varchar

Código	Descripción	Observación
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