Page Comparison

Web Services para Apertura de Caja

DESCRIPCIÓN.

Este Web Service, permite dar Apertura a la CAJA, para el inicio de las transacciones en la Aplicación SIFCO WEB, es importante indicar que se deben incluir detalles como empresa, sucursal, moneda, saldo inicial, ingreso, egreso y demás detalles para la apertura de la misma, adicionalmente se debe respetar el Flujograma Indicado en Web Services de Caja, dado a que ello garantizara que las transacciones se puedan ejecutar sin errores y perfectamente aceptadas y procesadas por la Aplicación SIFCO WEB.

Swagger open api macro

swagger: '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**, el cual permite dar Apertura a la CAJA, en el dia o cuando se vaya a registrar el primer movimiento en CAJA 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: "PCJApeCajero"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/woSo"
produces:
  - application/json
paths:
  /PCJApeCajero:
    post:
      tags:
        - PCJApeCajero
      operationId: "PCJApeCajero"
      summary: "Apertura de CAJA"
      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: "PCJApeCajeroInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/PCJApeCajeroInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/PCJApeCajeroInput"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        400:
          description: "Bad request"
          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 método tipo GET
      Insert: Permite el método tipo POST
      Update: Permite el método tipo PUT
      Delete: Permite el método tipo DELETE
      FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  PCJApeCajeroInput:
    properties:
      ApEmpCod:
        desription: Código de la Empresa
        type: "integer"
        format: "int32"
      ApSucCod:
        desription: Código de la Sucursal
        type: "integer"
        format: "int32"
      ApUsuCod:
        desription: Código de Promotor
        type: "string"
      ApMonCod:
        desription: Código de Moneda
        type: "integer"
        format: "int32"
      SaldoIni:
        desription: Saldo Inicial
        type: "number"
        format: "double"
      SIngreso:
        desription: Saldo de Ingreso
        type: "string"
      SEgreso:
        desription: Saldo de Egreso
        type: "string"
      ApCajRecCodigo:
        desription: Código de Cajero Receptor
        type: "integer"
        format: "int32"
      mensaje:
        type: "string"
      ok:
        type: "boolean"


  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

WSGarantiasCreditoInput

>Entrada

>WSGarantiaCreditoSDT

GaPPaiCod

WSApPaisLista

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 registrar diferentes tipos o modalidades de Garantías de Crédito en la Aplicación SIFCO WEB.

El siguiente ejemplo permite cargar un Tipo de Garantía para un Crédito en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block

language	html

https://test.sifco.org/democoopgt/rest/PCJApeCajero

HEADERS

Code Block

language	json

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

BODY:

Code Block

language	json

{
  "ApEmpCod": 1,
  "ApSucCod": 1,
  "ApUsuCod": "admin",
  "ApMonCod": 1,
  "SaldoIni": 1000,
  "SIngreso": "1500",
  "SEgreso": "1300",
  "ApCajRecCodigo": 1,
  "mensaje": "string",
  "ok": true
}

200 (Successful operation)

Operación Exitosa

Code Block

{
  "ApEmpCod": 1,
  "ApSucCod": 1,
  "ApUsuCod": "admin",
  "ApMonCod": 1,
  "SaldoIni": "1000.00",
  "SIngreso": "1500",
  "SEgreso": "1300",
  "ApCajRecCodigo": 1,
  "mensaje": "CAJA ABIERTA EXITOSAMENTE",
  "ok": true
}

400 (Bad Request).

Solicitud Errada

Code Block
{ "error": { "code": "string", "message": "string" } }

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
{ "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
{ "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 Caja, 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

language	json

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

spaceKey	DOC
placeholder	Búsqueda en esta Pagina
type	page

Enlaces Relevantes

Artículos Actualizados Recientemente

Recent updates

types	page
max	5
spaces	DOC
theme	concise
hideHeading	true

Change History

Versions Compared

Old Version 6

New Version 7

Key

DESCRIPCIÓN.

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

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

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente