Versions Compared

Old Version 4

changes.mady.by.user Alfredo Lopez

Saved on

compared with

New Version Current

changes.mady.by.user Alfredo Lopez

Saved on

Key

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

Web Services para Registro de Planes de Pagos de HUB de Créditos.

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 Planes de Pago en Hub de Créditos 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: "API.HUB.V1.PlanesPagoHubSifco" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/ugWo" produces: - application/json paths: /API/HUB/V1/PlanesPagoHubSifco: post: tags: - API.HUB.V1.PlanesPagoHubSifco operationId: "API.HUB.V1.PlanesPagoHubSifco"

DESCRIPCIÓN.

Este Web Service, permite una vez validado que el cliente tiene cupo de crédito y que cubre el monto de la compra, se consultará a cada cooperativa (donde tenga cupo suficiente) sobre los planes de pago disponibles para el otorgamiento de financiamiento..

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: "API.HUB.V1.PlanesPagoHubSifco"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/ugWo"
produces:
  - application/json
paths:
  /API/HUB/V1/PlanesPagoHubSifco:
    post:
      tags:
        - API.HUB.V1.PlanesPagoHubSifco
      operationId: "API.HUB.V1.PlanesPagoHubSifco"
      summary: "Registrar Planes de Pago en Hub de Créditos"
      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: "PlanesPagoHubSifcoInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/API.HUB.V1.PlanesPagoHubSifcoInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/API.HUB.V1.PlanesPagoHubSifcoOutput"

        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:

  API.HUB.V1.PlanesPagoHubSifcoInput:
    properties:
      data:
        description: SDTConsulta Planes Pago
        $ref: "#/definitions/SDTConsultaPlanesPago"
  
  SDTConsultaPlanesPago:
    properties:
      idHub:
        description: id Hub
        type: "string"

      idTransaccion:
        description: id Transacción
        type: "integer"
        format: "int64"

      idNegocio:
        description: id Negocio
        type: "integer"
        format: "int64"

      tipoIdentidadCliente:
        description: tipo Identidad Cliente
        type: "integer"
        format: "int32"

      identidadCliente:
        description: identidad Cliente
        type: "string"

      fechaCompra:
        description: fecha Compra
        type: "string"

      observacion:
        description: observación
        type: "string"

      idRelacionTP:
        description: id Relación TP
        type: "integer"
        format: "int64"

      idPrestador:
        description: id Prestador
        type: "integer"
        format: "int64"

      idRelacionPN:
        description: id Relación PN
        type: "integer"
        format: "int64"

      montoSolicitado:
        description: monto Solicitado
        type: "number"
        format: "double"
  
  API.HUB.V1.PlanesPagoHubSifcoOutput:
    properties:
      result:
        description: SDTPlanes Pago Result
        $ref: "#/definitions/SDTPlanesPagoResult"
  
  SDTPlanesPagoResult:
    properties:
      idTransaccion:
        description: id Transacción
        type: "integer"
        format: "int64"

      idNegocio:
        description: id Negocio
        type: "integer"
        format: "int64"

      idPrestador:
        description: id Prestador
        type: "integer"
        format: "int64"

      observacion:
        description: observación
        type: "string"

      montoSolicitado:
        description: monto Solicitado
        type: "integer"
        format: "int64"

      montoAprobado:
        description: monto Aprobado
        type: "number"
        format: "double"

      idTransaccionSifco:
        description: id Transacción Sifco
        type: "string"

      planesPago:
        type: array
        items:
          description: planesPagoItem
          $ref: "#/definitions/SDTPlanesPagoResult.planesPago"


  SDTPlanesPagoResult.planesPago:
    properties:
      idPlanPagoSifco:
        description: id Plan Pago Sifco
        type: "string"

      idRelacionPN:
        description: id Relación PN
        type: "integer"
        format: "int64"

      idRelacionTP:
        description: id Relacion TP
        type: "integer"
        format: "int64"

      nombrePlanPago:
        description: nombre Plan Pago
        type: "string"

      descripcionPlanPago:
        description: descripción Plan Pago
        type: "string"

      numeroCuotasPlanPago:
        description: numero Cuotas Plan Pago
        type: "integer"
        format: "int32"

      valorCuotaPlanPago:
        description: valor Cuota Plan Pago
        type: "number"
        format: "double"

      diaVencimiento:
        description: dia Vencimiento
        type: "integer"
        format: "int32"

      vencimientoPrimeraCuota:
        description: vencimiento Primera Cuota
        type: "string"

      vencimientoUltimaCuota:
        description: vencimiento Ultima Cuota
        type: "string"

      tasaMensualPlanPago:
        description: tasa Mensual Plan Pago
        type: "number"
        format: "double"

      tasaAnualPlanPago:
        description: tasa Anual Plan Pago: numero Cuotas Plan Pago
        type: "integer"
        format: "int32"

      valorCuotaPlanPago:
        description: valor Cuota Plan Pago
        type: "number"
        format: "double"

      diaVencimiento:
        description: dia Vencimiento
        type: "integer"
        format: "int32"

      vencimientoPrimeraCuota:
        description: vencimiento Primera Cuota
        type: "string"

      vencimientoUltimaCuota:
        description: vencimiento Ultima Cuota
        type: "string"

      tasaMensualPlanPago:
        description: tasa Mensual Plan Pago
        type: "number"
        format: "double"

      tasaAnualPlanPago:
        description: tasa Anual Plan Pago
        type: "number"
        format: "double"

      tasaInteresPlanPago:
        description: tasa Interés Plan Pago
        type: "number"
        format: "double"

      cae:
        description: cae
        type: "number"
        format: "double"

      montoCostosAsociados:
        description: monto Costos Asociados
        type: "number"
        format: "double"

      montoCredito:
        description: monto Crédito
        type: "number"
        format: "double"


    x-gx-level: "SDTPlanesPagoResult"

  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"

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 Consultar los Planes de Pagos según el cupo disponible del Cliente en cada cooperativa abierta en el HUB de Créditos de la Aplicación SIFCO WEB.

El siguiente ejemplo permite Consultar un Plan de Pago de un Cliente en el HUB de Créditos en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block
languagehtml
https://test.sifco.org/democoopgt/rest/API/HUB/V1/PlanesPagoHubSifco

HEADERS

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

BODY:

Code Block
languagejson
{
  "data": {
    "idHub": "string",
    "idTransaccion": 0,
    "idNegocio": 0,
    "tipoIdentidadCliente": 0,
    "identidadCliente": "string",
    "fechaCompra": "string",
    "observacion": "string",
    "idRelacionTP": 0,
    "idPrestador": 0,
    "idRelacionPN": 0,
    "montoSolicitado": 0
  }
}

200 (Successful operation)

(Registro Creado con Éxito)

Code Block
languagejson
{
  "result": {
    "idTransaccion": 0,
    "idNegocio": 0,
    "idPrestador": 0,
    "observacion": "string",
    "montoSolicitado": 0,
    "montoAprobado": 0,
    "idTransaccionSifco": "string",
    "planesPago": [
      {
type
"idPlanPagoSifco": "
number
string"
,
format:
 "
double
idRelacionPN": 0,
tasaInteresPlanPago:
  "idRelacionTP": 0,
description:
tasa
Interés
Plan Pago
"nombrePlanPago": "string",
type
"descripcionPlanPago": "
number
string",
format: "double"
"numeroCuotasPlanPago": 0,
cae
"valorCuotaPlanPago": 0,
description
 "diaVencimiento":
cae
0,
type
"vencimientoPrimeraCuota": "
number
string",
format
"vencimientoUltimaCuota": "
double
string",
montoCostosAsociados
"tasaMensualPlanPago": 0,
description
 "tasaAnualPlanPago":
monto
0,
Costos
Asociados
type: "number"
"tasaInteresPlanPago": 0,
format: "double"
"cae": 0,
montoCredito
"montoCostosAsociados": 0,
description
"montoCredito":
monto
0
Crédito
      }
type:
"number"
 ]
format: "double" 
}
}

400 (Bad Request).

Solicitud Errada

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

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"
x-gx-level: "GxJsonError" 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 Hub de Créditos, dado a que en caso de no seguirlo al pie de la letra puede generar errores inesperados en la ejecución
}
}
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.

Enlaces Relevantes

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Artículos Relacionados

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "informacion" , "tecnica" , "api" , "rest" , "web" , "services" , "hub" , "planes" , "pagos" , "creditos" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History