Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API WS

Expand
titleAPI WS

IntroduccionIntroducció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.

Expand
titleURLs

Entorno de pruebas

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

Entorno de

produccion

producción

La

direccion

dirección para

produccion sera

producción será proporcionada por Cabal

Expand
titleAuthentication User
Descripcion

Descripción

Esta

transaccion

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

URI

URIInput TypeOutput Type
/
autheticationUser
authenticationUserPOST, Content-Type:application/x-www-form-urlencodedContent-Type:
applicatoin
application/json
Parametros

Parámetros de ingreso

NombreTipoObligatorio?
Descripcion
Descripción
1uservarcharSi
2passwordvarcharSi
Parametros

Parámetros de egreso

NombreTipoObligatorio?
Descripcion
Descripción
1SIDvarcharSi
2exitCodenumericNo
3messageCodevarcharNo
Expand
titleAuthorization User
Descripcion 

Descripción 

Esta

transaccion

transacción permite obtener los datos de acceso del usuario, sus roles, plataformas, perfiles.

URI

URIInput TypeOutput Type
*authorizationUserPOST, Conten-Type: application/x-www-form-urlencodedConten-Type:application/json
Parametros

Parámetros de ingreso

NombreTipoObligatorio?
Descripcion
Descripción
1SIDnumericSiSession ID
Parametros

Parámetros de egreso

Nombre

Tipo

Obligatorio?
Descripcion
Descripción
1platformslistSi
2roleslist

3profileslist

4exitCodenumeric

5messageCodevarchar

Expand
titleGet Platform User
Descripcion

Descripción

Esta

transaccion

transacción permite obtener las plataformas a las que puede accedes un usuario

URI

URIInput TypeOutput Type
/getPlatformsUserPOST, Conten-Type: application/x-www-form-urlencodedContent-Type:application/json
Parametros

Parámetros de ingreso

NombreTipoObligatorio?
Descripcion
Descripción
1SIDnumericSiSession ID
Parametros

Parámetros de egreso

NombreTipoObligatorio?
Descripcion
Descripción
1

platforms

listSi
2exitCodenumeric

5messageCodevarchar
Codigos


Expand
titleCódigos de respuesta WS
Codigo
Código
Descripcion
Descripción
Observacion
Observación
0Resultado exitosoSe obtiene del campo "exitCode". Si el codigo es cero, no hay mensaje de salida en la variable "messageCode"
-1Se ha producido un errorEn el campo "messageCode" viene la descripcion del error