Versions Compared

Old Version 2

changes.mady.by.user Alfredo Lopez (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Alfredo Lopez (Unlicensed)

Saved on

Key

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

Web Services para realizar Depósitos o Retiros por BackOffice.

Swagger open api macroswagger: '2.0' info: title: "SIFCO_REST_API" version: "1.0" description: "La presente documentación busca detallar los métodos que permite ejecutar este **Web Services**, como es Registrar Solicitud de Cotización de un Crédito en la **Aplicación SIFCO WEB** ." termsOfService: "https://sifco.org/sobre-nosotros/" contact: email: "soporte@sifco.org" license: name: "Apache 2.0" url: "http://www.apache.org/licenses/LICENSE-2.0.html" host: "<SERVER>" schemes: - https - http basePath: /<APPDIR>/rest tags: - name: "WSCaDepositosRetiros" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/gwDQ" produces: - application/json paths: /WSCaDepositosRetiros: post: tags: - WSCaDepositosRetiros operationId: "WSCaDepositosRetiros" summary: "Web Service para Registro de Depositos y/o Retiros por BackOffice, fuera de Caja" parameters: - in: header name: Content-Type type: "string" required: true default: application/json

DESCRIPCIÓN.

Este Web Service, permite registrar una operación de Deposito o Retiro fuera de Caja (BackOffice) en la Aplicación SIFCO WEB.

Swagger open api macro
swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  termsOfService: "https://sifco.org/sobre-nosotros/"
  contact:
    email: "soporte@sifco.org"
  license:
    name: "Apache 2.0"  
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
basePath: /<APPDIR>/rest
tags:
- name: "WSCaDepositosRetiros"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/gwDQ"
produces:
  - application/json
paths:
  /WSCaDepositosRetiros:
    post:
      tags:
        - WSCaDepositosRetiros
      operationId: "WSCaDepositosRetiros"
      summary: "Web Service para Registro de Depositos y/o Retiros por BackOffice, fuera de Caja"
      parameters:
         - in: header
          name: AuthorizationContent-Type
          type: "string"
          required: true
          default: OAuthapplication/json
<Access Token>
        - in: header
          name: GENEXUS-AGENTAuthorization
          type: "string"
          required: true
          default: SmartDeviceOAuth <Access ApplicationToken>
        - in: header
          name: "WSCaDepositosRetirosInput"GENEXUS-AGENT
          intype: "bodystring"
          required: falsetrue
          schemadefault: SmartDevice Application
        -  $refname: "#/definitions/WSCaDepositosRetirosInput"
       responses:       in: "body"
 200:           descriptionrequired: "Successfulfalse
operation"
          schema:
            $ref: "#/definitions/WSCaDepositosRetirosOutputWSCaDepositosRetirosInput"

      responses:
      401  200:
          description: "NotSuccessful Authenticatedoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorWSCaDepositosRetirosOutput"

        404401:
          description: "Not foundAuthenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        400404:
          description: "BadNot requestfound"
          schema:
            $ref: "#/definitions/GxJsonError"
        500400:
          description: "InternalBad server errorrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
security:   -  OAuth2: []  500:
  ApiKeyAuth1: [] securityDefinitions:   OAuth2:   description: "Internal type:server oauth2error"
    flow: password     tokenUrlschema:
https://test.sifco.org/DemoCoopGT/oauth/access_token     scopes:       Execute$ref: Permite el método tipo GET
      Insert: Permite el método tipo POST
      Update: Permite el método tipo PUT
"#/definitions/GxJsonError"
security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: oauth2
     Deleteflow: Permite el métodopassword
tipo DELETE   tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
  FullControl: Permite elscopes:
manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobreExecute: Permite el Webmétodo Servicetipo GET
 ApiKeyAuth1:     typeInsert: apiKeyPermite el método tipo POST
in: header     nameUpdate: granttypePermite el definitions:método tipo PUT
 WSCaDepositosRetirosInput:     propertiesDelete: Permite el método tipo DELETE
 BackOffice:     FullControl: Permite el manejo description:de WSCalos DepositosCuatro RetirosMétodos SDTGET, POST, PUT,DELETE, sobre el Web Service
  $refApiKeyAuth1:
"#/definitions/WSCaDepositosRetirosSDT"    WSCaDepositosRetirosOutputtype: apiKey
    in: header
    name: granttype

definitions:

  WSCaDepositosRetirosInput:
    properties:
      ResultadoBackOffice:
        description: WSCa Depositos Retiros SDT_Result
        $ref: "#/definitions/WSCaDepositosRetirosSDT_Result"

    WSCaDepositosRetirosSDTWSCaDepositosRetirosOutput:
    properties:
      DepositosRetirosResultado:
        typedescription: arrayWSCa Depositos Retiros SDT_Result
     items:           description: DepositosRetirosItem
          $ref: $ref: "#/definitions/WSCaDepositosRetirosSDT.DepositosRetiros_Result"
  
  WSCaDepositosRetirosSDT.DepositosRetiros:
    properties:
      CodigoSocioDepositosRetiros:
        descriptiontype: Códigoarray
del Cliente        items:
type: "integer"         formatdescription: "int64"DepositosRetirosItem
       NumeroCuenta:   $ref: "#/definitions/WSCaDepositosRetirosSDT.DepositosRetiros"


  descriptionWSCaDepositosRetirosSDT.DepositosRetiros:
Número de Cuenta Captaciones properties:
       typeCodigoSocio:
"string"        TipoMovimientodescription: Código del Cliente
      description  type: Tipo"integer"
Movimiento         typeformat: "stringint64"

      EsMovimientoBancarioNumeroCuenta:
        description: Número Esde MovimientoCuenta BancarioCaptaciones
        type: "string"

      TipoMovimientoBancarioTipoMovimiento:
        description: Tipo Movimiento
        type: "string"

      EsMovimientoBancario:
        description: Es Movimiento Bancario
        type: "string"

      EsChequeTipoMovimientoBancario:
        description: Tipo EsMovimiento ChequeBancario
        type: "string"

      EsDepositoEsCheque:
        description: Es Deposito
        type: "string"

      CodigoCuentaBancaria:
        description: Código de Cuenta Bancaria
        type: "integer"
        description: Es Cheque
        type: "string"

      EsDeposito:
        description: Es Deposito
        type: "string"

      CodigoCuentaBancaria:
        description: Código de Cuenta Bancaria
        type: "integer"
        format: "int64"

      NumeroBoleta:
        description: Numero Boleta Deposito
        type: "integer"
        format: "int64"

      NombreEmiteCheque:
        description: Nombre a quien Emite Cheque
        type: "string"

      Monto:
        description: Monto
        type: "number"
        format: "double"

      Referencia:
        description: Referencia Documento
        type: "string"

      NumeroMovimiento:
        description: Número del Movimiento Diario
        type: "integer"
        format: "int64"

      NumeroCuentaBancaria:
        description: Número de la Cuenta
        type: "string"


    x-gx-level: "WSCaDepositosRetirosSDT"


  WSCaDepositosRetirosSDT_Result:
    properties:
      Success:
        description: Success
        type: "boolean"

      NumeroCuenta:
        description: Numero Cuenta
        type: "string"

      Descripcion:
        description: Descripción
        type: "string"

  GxJsonError:
    properties:
      error:
        $ref: "#/definitions/GxJsonError.error"

  GxJsonError.error:
    properties:
      code:
        description: Código de Error
        type: "string"

      message:
        description: Mensaje de Error
        type: "string"


    x-gx-level: "GxJsonError"

RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful DE LA APLICACIÓN SIFCO WEB.

Modelo de Datos de este Web Service

Web Service a Constantes del Sistema Relacionados

WSCaDepositosRetirosInput

>WSCaDepositosRetirosSDT

>WSCaDepositosRetirosSDT.DepositosRetiros

CodigoCuentaBancaria

WSApCuentasBancosLista

NumeroCuenta

WSApCuentasBancosLista

CodigoSocio

TClClientes

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

A continuación se muestra una tabla con un ejemplo de una Solicitud y un Respuesta para este Web Service.

METODO POST

Este método para este Web Service en especifico registrar una operación de Deposito o Retiro fuera de Caja (BackOffice) en la Aplicación SIFCO WEB..

El siguiente ejemplo permite registrar una operación de Deposito fuera de Caja (BackOffice) en la Aplicación SIFCO WEB..

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block
languagehtml
https://test.sifco.org/democoopgt/rest/WSCaDepositosRetiros

HEADERS

Code Block
languagejson
content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application

BODY:

Code Block
languagejson
{
    "BackOffice":{
format
"DepositosRetiros":[
"int64"
NumeroBoleta:
 {
description:
Numero
Boleta
Deposito
    "CodigoSocio":"10",
type:
"integer"
format
"NumeroCuenta":
"
int64
123456789",
NombreEmiteCheque:
description: Nombre a quien Emite Cheque
"TipoMovimiento":"D",
type
"EsMovimientoBancario":
"
string
N",
Monto:
description: Monto
"TipoMovimientoBancario":"",
type:
"number"
format: "double"
"EsCheque":"S",
Referencia:
      "EsDeposito":"S",
description:
Referencia
Documento
type:
 "
string
CodigoCuentaBancaria":0,
NumeroMovimiento:
description: Número del Movimiento Diario
"NumeroBoleta":"0",
type
"NombreEmiteCheque":
"
integer
",
format
  "Monto":
"
int64
500",
NumeroCuentaBancaria:
       "Referencia":"Descriptivo…",
description:
Número
de
la
Cuenta
type
"NumeroMovimiento":
"
string
0",
x-gx-level:
"WSCaDepositosRetirosSDT"
WSCaDepositosRetirosSDT_Result:
  "NumeroCuentaBancaria":""
properties:
Success:
 }
description:
Success
]
    }
type: "boolean"
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{  
   "Resultado":[
     {  
      "Success": true,
      "NumeroCuenta":
description: Numero Cuenta type: "string" 
"123456789",
      "Descripcion":"Proceso Finalizado Exitosamente...!!!"
   	 }
   ]
Descripcion: 
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "error": {
description
"code":
Descripción
"string",
type
"message": "string"
GxJsonError: properties: error: 
}
}

401 (This service needs an Authorization Header)

(No Autenticado, asociado normalmente a que no se respetaron las cabeceras obligatorias para el consumo de este Web Service, para mayores detalles consultar (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services) ).

Code Block
languagejson
{
  "error": {
$ref: "#/definitions/GxJsonError.error" GxJsonError.error: properties: code: description: Código de Error type
"code":"0",
    "message":"This service needs an Authorization Header"
  }
}
{
  "Resultado": {}
}

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado)

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

Code Block
languagejson
{
  "error": {
    "code": "string",
    
"message": "string"
description: Mensaje de Error type: "string" x-gx-level: "GxJsonError"
}
}
Info

INFORMACIÓN

Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de Mensajes), donde se describe el listado de mensajes que arroja las API’s REST de la Aplicación SIFCO WEB, con su respectiva Descripción.

Note

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Code Block
languagejson
Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application
Warning

EN CASO DE ERROR HTTP 401 (Not Authenticated)

Por favor validar que esta colocando los Encabezados Adecuadamente, y de persistir el problema dirigirse a la Pagina (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services), para generar nuevamente su Token de Acceso, y/o verificar problemas con su acceso al API REST.

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Enlaces Relevantes

Artículos Relacionados

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "informacion" , "tecnica" , "web" , "services" , "api" , "rest" , "ahorros" , "depositos" , "retiros" , "backoffice" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History