Versions Compared

Version Old Version 3 New Version Current
Changes made by

Alfredo Lopez

Alfredo Lopez

Saved on

Key

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

Web Services para Registrar o Modificar las Referencias Bancarias de un Cliente.

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 o Modificar las Referencias Bancarias de un cliente 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: "TClRefBancarias" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/FADU" produces: - application/json paths: /TClRefBancarias/{ClCliCod}: get: tags: - TClRefBancarias operationId: "GetTClRefBancarias

DESCRIPCIÓN.

Este Web Service, permite el ingreso de detalles específicos del cliente (asociado / socio) en la Aplicación SIFCO WEB, permitiendo incluir, agregar o modificar solo las Cuentas Bancarias suministrados por el cliente con sus detalles respectivos. Es importante acotar que para la correcta carga de los parámetros de un cliente en este Web Service, se deben revisar las Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB y Web Services de Consulta de Categorías Generales, dado a que ellos les permitan cargas los parámetros de este Web Service de forma adecuada 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"  
    summaryurl: "Consultar las Referencias Bancarias de un Cliente en el Sistema"
      parameters:
   http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
basePath: /<APPDIR>/rest
tags:
- name: "TClRefBancarias"
  externalDocs:
    - indescription: header"Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/FADU"
produces:
  name: Content-Type application/json
paths:
  /TClRefBancarias/{ClCliCod}:
     typeget:
"string"      tags:
        - TClRefBancarias
      operationId: "GetTClRefBancarias"
    required  summary: true
    "Consultar las Referencias Bancarias de un Cliente en el Sistema"
     default parameters:
application/json
        - in: header
          name: AuthorizationContent-Type
          type: "string"
          required: true
          default: OAuth <Access Token>application/json
        - in: header
          name: GENEXUS-AGENTAuthorization
          type: "string"
          required: true
          default: SmartDeviceOAuth Application<Access Token>
        - namein: "ClCliCod"header
          inname: "path"GENEXUS-AGENT
          descriptiontype: "Código del Clientestring"
          required: true
          typedefault: "integer"SmartDevice Application
        - formatname: "int64ClCliCod"
          in: "path"
 responses:         200description: "Código del Cliente"
       description   required: "Successfultrue
operation"           schematype: "integer"
           $refformat: "#/definitions/TClRefBancariasint64"
      
 400     responses:
        200:
          description: "BadSuccessful requestoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClRefBancarias"
        401400:
          description: "NotBad Authenticatedrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
        404401:
          description: "Data with the specified key could not be foundNot Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        500404:
          description: "Internal server errorData with the specified key could not be found"
          schema:
            $ref: "#/definitions/GxJsonError"
     post   500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    post:
      tags:
        - TClRefBancarias
      operationId: "InsertTClRefBancarias"
      summary: "Insertar las Referencias Bancarias de un Cliente en el Sistema"
      parameters:
        - in: header
          name: Content-Type
          type: "string"
          required: true
          default: application/json
        - in: header
          name: Authorization
          type: "string"
          required: true
          default: OAuth <Access Token>
        - in: header
          name: GENEXUS-AGENT
          type: "string"
          required: true
          default: SmartDevice Application
        - name: "ClCliCod"
          in: "path"
          description: "Código del Cliente"
          required: true
          type: "integer"
          format: "int64"
        - name: "TClRefBancarias"
          in: "body"
          description: "SDT of TClRefBancarias"
          required: false
          schema:
            $ref: "#/definitions/TClRefBancarias"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClRefBancarias"
        201:
          description: "Created"
          schema:
            $ref: "#/definitions/TClRefBancarias"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Data with the specified key could not be found"
          schema:
            $ref: "#/definitions/GxJsonError"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    put:
      tags:
        - TClRefBancarias
      operationId: "UpdateTClRefBancarias"
      summary: "Actualizar las Referencias Bancarias de un Cliente en el Sistema"
      parameters:
        - in: header
          name: Content-Type
          type: "string"
          required: true
          default: application/json
        - in: header
          name: Authorization
          type: "string"
          required: true
          default: OAuth <Access Token>
        - in: header
          name: GENEXUS-AGENT
          type: "string"
          required: true
          default: SmartDevice Application
        - name: "ClCliCod"
          in: "path"
          description: "Código del Cliente"
          required: true
          type: "integer"
          format: "int64"
        - name: "TClRefBancarias"
          in: "body"
          description: "SDT of TClRefBancarias"
          required: true
          schema:
            $ref: "#/definitions/TClRefBancarias"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClRefBancarias"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        409:
          description: "TClRefBancarias was changed"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    
deletesecurity:
  - OAuth2: []
 tags:   ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
- TClRefBancarias   type: oauth2
  operationId: "DeleteTClRefBancarias" flow: password
    summarytokenUrl: "Eliminar las Referencias Bancarias de un Cliente en el Sistema"
      parameters:
https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      Execute: Permite el método tipo GET
       - inInsert: headerPermite el método tipo POST
      nameUpdate: Content-TypePermite el método tipo PUT
      typeDelete: "string"Permite el método tipo DELETE
      requiredFullControl: truePermite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre default: application/json
el Web Service
  ApiKeyAuth1:
    - intype: headerapiKey
    in: header
    name: Authorizationgranttype

definitions:

  TClRefBancarias:
    typeproperties:
"string"      ClCliCod:
    required: true   description: Código del Cliente
       default type: OAuth <Access Token>"integer"
        format: "int64"

  - in: header  ClNomSocio:
        namedescription: GENEXUS-AGENTNombre del Cliente
        type: "string"

         required: trueRefBanUlt:
          defaultdescription: SmartDeviceUltima ApplicationReferencia Bancaria
       - nametype: "ClCliCodinteger"
          informat: "pathint32"

      gx_md5_hash:
  description: "Código del Cliente"   description: gx_md5_hash is an identifier for a specific required:version trueof a resource, it is used for optimistic concurrency check. It type: "integer"
          format: "int64"is required for update and delete operations and  ignored on insert.
         responsestype: "string"

      200Level1:
          description$ref: "Successful operation"#/definitions/TClRefBancarias.Level1Item"

    required:
     schema: - ClCliCod

  TClRefBancarias.Level1Item:
      $ref: "#/definitions/TClRefBancarias"properties:
        204RefBanCor:
          description: "SuccessfulReferencia operation"Bancaria
          schematype: "integer"
           $refformat: "#/definitions/TClRefBancariasint32"

       400ApBanCod:
          description: "BadCódigo request"Banco
          schematype: "integer"
        format: "int32"

    $ref  ApBanNombre:
"#/definitions/GxJsonError"         401description: Nombre
         descriptiontype: "string"Not

  Authenticated"    RefBanTCta:
      schema  description: Tipo de Cuenta
        type: "integer"
 $ref       format: "#/definitions/GxJsonError"int32"

      RefBanNCta:
   404:     description: Número      description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"


security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: oauth2
    flow: password
    tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      Execute: Permite el metodo tipo GET
      Insert: Permite el metodo tipo POST
      Update: Permite el metodo tipo PUT
      Delete: Permite el metodo tipo DELETE
      FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  TClRefBancarias:
    properties:
      ClCliCod:
        description: Código del Cliente
        type: "integer"
        format: "int64"

      ClNomSocio:
        description: Nombre del Cliente
de la Cuenta
        type: "string"

      RefBanEstatus:
        description: Estatus de la Referencia Bancaria
        type: "string"


    required:
      - RefBanCor
    x-gx-level: "TClRefBancarias"

  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

TClRefBancarias

>TClRefBancarias.Level1

ApBanCod

WSApBancosLista

RefBanTCta

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

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 permite agregar una Cuenta Bancaria a un Cliente en la Aplicación SIFCO WEB.

El siguiente ejemplo inserta una Cuenta Bancaria a un cliente en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

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

HEADERS

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

BODY:

Code Block
languagejson
{
    "ClCliCod": "3",
    "ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
    "RefBanUlt": 1,
        "Level1": [
          {
              "RefBanCor": 1,
              "ApBanCod": 1,
              "ApBanNombre": "BANCO EJEMPLO",
              "RefBanTCta": 1,
              "RefBanNCta": "564843481-1",
              "RefBanEstatus": "P",
              "RefInstrucciones": ""
          }
        ],
    "ClExcluirCorreosElectronicos": 0,
    "gx_md5_hash": "C65A6DBB33EF2AD159D591C48E3FF0C4"
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
    "ClCliCod": "3",
    "ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
    "RefBanUlt": 1,
type:
 "
string
Level1": [
RefBanUlt:
    {
description:
Ultima
Referencia
Bancaria
type: 
"
integer
RefBanCor": 1,
format: "int32"
gx_md5_hash
"ApBanCod": 1,
description:
gx_md5_hash
is
an
identifier
for
a
specific version of a resource, it is used for optimistic concurrency check. It is required for update and delete operations and ignored on insert.
"ApBanNombre": "BANCO EJEMPLO",
              "RefBanTCta": 1,
type
"RefBanNCta": "
string
564843481-1"
,
Level1:
$ref
"RefBanEstatus": "
#/definitions/TClRefBancarias.Level1Item" 
P",
required:
-
ClCliCod
TClRefBancarias.Level1Item
"RefInstrucciones": ""
properties:
RefBanCor:
}
description:
],
Referencia
Bancaria
   "ClExcluirCorreosElectronicos": 0,
type
"gx_md5_hash": "
integer"
C65A6DBB33EF2AD159D591C48E3FF0C4"
}

201 (Created)

(Registro Creado con Éxito)

Code Block
languagejson
{
format
"ClCliCod": "
int32
3",
ApBanCod
"ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
description: Codigo
Banco
type: "integer" 
"RefBanUlt": 1,
format:
 "
int32" ApBanNombre
Level1": [
description:
Nombre
  {
type: "string"
RefBanTCta
"RefBanCor": 1,
description:
Tipo
de
Cuenta
   "ApBanCod": 1,
type:
"integer"
format
"ApBanNombre": "
int32
BANCO EJEMPLO",
RefBanNCta:
       "RefBanTCta": 1,
description:
Número
de
la
Cuenta
type
"RefBanNCta": "
string
564843481-1",
              "RefBanEstatus": "P",
description:
Estatus
de
la Referencia Banca
"RefInstrucciones": ""
type:
"string"
}
required:
  ],
- RefBanCor
"ClExcluirCorreosElectronicos": 0,
x-gx-level
"gx_md5_hash": "
TClRefBancarias
C65A6DBB33EF2AD159D591C48E3FF0C4"
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
GxJsonError
"error": {
properties:
"code": "string",
    "message": "string"
error:
$ref: "#/definitions/GxJsonError.error" GxJsonError.error: properties: code: description: Codigo de Error type: "string" message: description: Mensaje de Error type: "string" x-gx-level: "GxJsonError"
}
}

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": {
    "code":"0",
    "message":"This service needs an Authorization Header"
  }
}

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"
  }
}
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

NO DEBE OLVIDAR

NO olvide tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Clientes, dado a que en caso de no seguirlo al pie de la letra puede generar errores inesperados en la ejecució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" , "api" , "rest" , "web" , "services" , "clientes" , "referencias" , "bancarias" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History