SISTEMAS
Page tree

Versions Compared

Old Version 4

changes.mady.by.user Sistemas

Saved on

compared with

New Version Current

changes.mady.by.user Sistemas

Saved on

Key

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

...

Expand
titleAPI 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.

Expand
titleURLs

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

Expand
titleAuthentication User

Descripción

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

URI

autheticationUserapplicatoin
URIInput TypeOutput Type
/authenticationUserPOST, Content-Type:application/x-www-form-urlencodedContent-Type:application/json

Parámetros de ingreso

N°NombreTipoObligatorio?Descripción
1uservarcharSi
2passwordvarcharSi

Parámetros de egreso

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

Descripción 

Esta 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

Parámetros de ingreso

N°NombreTipoObligatorio?Descripción
1SIDnumericSiSession ID

Parámetros de egreso

N°Nombre

Tipo

Obligatorio?Descripción
1platformslistSi
2roleslist

3profileslist

4exitCodenumeric

5messageCodevarchar
Get Platform User


Expand
titleGet Platform User

Descripción

Esta 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

Parámetros de ingreso

N°NombreTipoObligatorio?Descripción
1SIDnumericSiSession ID

Parámetros de egreso

N°NombreTipoObligatorio?Descripción
1

platforms

listSi
2exitCodenumeric

5messageCodevarchar

Expand
titleCódigos de respuesta WS
CódigoDescripciónObservació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