Versions Compared

Old Version 5

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 Notificación Cooperativa a 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 Notificacion Cooperativa a 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.NotificacionCooperativa" externalDocs: description: "Manual SIFCO"

DESCRIPCIÓN.

Este Web Service, permite realizar una Notificación sobre la ejecución de un proceso particular dentro del HUB de Créditos de la Aplicación SIFCO WEB. Donde una vez firmada y cargada la documentación requerida para un Crédito, la transacción puede darse por cerrada y con ello se notifica a la Cooperativa de Crédito sobre el Crédito cursado.

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: "httpshttp://sifcowww.atlassianapache.netorg/wiki/x/mAWo"
produces:
  - application/json
paths:
  /API/HUB/V1/NotificacionCooperativa:
    post:
      tags:
        - licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
basePath: /<APPDIR>/rest
tags:
- name: "API.HUB.V1.NotificacionCooperativa"
  externalDocs:
    operationIddescription: "API.HUB.V1.NotificacionCooperativaManual SIFCO"
    url:  summary: "Notificacion Cooperativa a Hub de Créditos"
 "https://sifco.atlassian.net/wiki/x/mAWo"
produces:
  - application/json
paths:
  /API/HUB/V1/NotificacionCooperativa:
    parameterspost:
        - intags:
header           name: Content-Type- API.HUB.V1.NotificacionCooperativa
          typeoperationId: "stringAPI.HUB.V1.NotificacionCooperativa"
      summary: "Notificacion Cooperativa a required:Hub truede Créditos"
         defaultparameters:
application/json
        - in: header
          name: AuthorizationContent-Type
          type: "string"
          required: true
          default: OAuthapplication/json
<Access Token>       -  - in: header
          name: GENEXUS-AGENTAuthorization
          type: "string"
          required: true
          default: OAuth SmartDevice<Access ApplicationToken>
        - in: header
          name: "NotificacionCooperativaInput"GENEXUS-AGENT
          intype: "bodystring"
          required: falsetrue
          schemadefault: SmartDevice Application
        -  $refname: "#/definitions/API.HUB.V1.NotificacionCooperativaInput"
       responses:      in: "body"
  200:           descriptionrequired: "Successfulfalse
operation"
          schema:
            $ref: "#/definitions/API.HUB.V1.NotificacionCooperativaOutputNotificacionCooperativaInput"

      responses:
   401     200:
          description: "NotSuccessful Authenticatedoperation"
          schema:
            $ref: "#/definitions/GxJsonError"API.HUB.V1.NotificacionCooperativaOutput"

        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 metodo tipo GET
 "#/definitions/GxJsonError"
security:
  - OAuth2: []
    InsertApiKeyAuth1: Permite[]
elsecurityDefinitions:
metodo tipo POSTOAuth2:
      Updatetype: Permiteoauth2
el metodo tipo PUT flow: password
    DeletetokenUrl: Permite el metodo tipo DELETE
https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      FullControlExecute: Permite el metodo tipo manejoGET
de los Cuatro Metodos GET, POST, PUT,DELETE, sobre Insert: Permite el Webmétodo Servicetipo POST
 ApiKeyAuth1:     typeUpdate: apiKeyPermite el método tipo PUT
in: header     nameDelete: granttypePermite el definitions:método tipo DELETE
 API.HUB.V1.NotificacionCooperativaInput:     properties:
      data:
   FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    descriptiontype: apiKey
SDTNotificacion Cooperativa   in: header
    $refname: granttype

"#/definitions/SDTNotificacionCooperativa"definitions:

  SDTNotificacionCooperativaAPI.HUB.V1.NotificacionCooperativaInput:
    properties:
      idHubdata:
        description: SDTNotificacion Cooperativa
        $ref: "#/definitions/SDTNotificacionCooperativa"

  SDTNotificacionCooperativa:
    properties:
      idHub:
        description: id Hub
        type: "string"

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

      planesPagoCursados:
        type: array
        items:
          description: planesPagoCursadosItem
          $ref: "#/definitions/SDTNotificacionCooperativa.planesPagoCursados"

  SDTNotificacionCooperativa.planesPagoCursados:
    properties:
      idTransaccion:
        description: id TransaccionTransacción
        type: "integer"
        format: "int64"

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

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

      identidadCliente:
        description: identidad Cliente
        type: "string"

      fechaRespuestaPlan:
        description: fecha Respuesta Plan
        type: "string"

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

      idOperacionNegocio:
        description: id OperacionOperación Negocio
        type: "string"

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

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

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

      idPlanPago:
        description: id Plan Pago
        type: "integer"
        format: "int64"

      idPlanPagoSifco:
        description: id Plan Pago Sifco
        type: "string"

      comprobanteVenta:
        description: comprobante Venta
        type: "integer"
        format: "int64"

      serieComprobanteVenta:
        description: serie Comprobante Venta
        type: "string"

      montoComprobanteVenta:
        description: monto Comprobante Venta
        type: "number"
        format: "double"

      fechaComprobanteVenta:
        description: fecha Comprobante Venta
        type: "number"
        format: "double"

      fechaComprobanteVenta:
        description: fecha Comprobante Venta
        type: "string"

      codigoAutorizacion:
        description: codigo Autorizacion
        type: "string"


    x-gx-level: "SDTNotificacionCooperativa"

  API.HUB.V1.NotificacionCooperativaOutput:
    properties:
      result:type: "string"

      codigoAutorizacion:
        description: código Autorización
        type: "string"


    x-gx-level: "SDTNotificacionCooperativa"

  API.HUB.V1.NotificacionCooperativaOutput:
    properties:
      result:
        description: SDTNotificacion Cooperativa Result
        $ref: "#/definitions/SDTNotificacionCooperativaResult"

  SDTNotificacionCooperativaResult:
    properties:
      idPrestador:
        description: id Prestador
        type: "integer"
        format: "int32"

      acuseRecibo:
        type: array
        items:
          description: acuseReciboItem
          $ref: "#/definitions/SDTNotificacionCooperativaResult.acuseRecibo"


  SDTNotificacionCooperativaResult.acuseRecibo:
    properties:
      idTransaccion:
        description: id Transacción
        type: "integer"
        format: "int64"

      idTransaccionSifco:
        description: id Transaccion Sifco
        type: "string"

      fechaOperacionPrestador:
        description: fecha Operación Prestador
        type: "string"

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


    x-gx-level: "SDTNotificacionCooperativaResult"
 
  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 Notificación sobre la ejecución de un proceso particular dentro del HUB de Créditos en la Aplicación SIFCO WEB.

El siguiente ejemplo permite Notificación sobre la ejecución de un proceso particular dentro del 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/NotificacionCooperativa

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",
    "idPrestador": 0,
    "planesPagoCursados": [
      {
        "idTransaccion": 0,
        "idTransaccionSifco": "string",
description
"tipoIdentidadCliente":
SDTNotificacion
0,
Cooperativa
Result
$ref
"identidadCliente": "
#/definitions/SDTNotificacionCooperativaResult
string",
SDTNotificacionCooperativaResult:
properties:
"fechaRespuestaPlan": "string",
idPrestador:
"idNegocio": 0,
description
"idOperacionNegocio":
id Prestador
"string",
type: 
"
integer
idRelacionPN": 0,
format:
 "
int32
idRelacionTP": 0,
acuseRecibo:
"montoAprobado": 0,
type
"idPlanPago":
array
0,
items
"idPlanPagoSifco": "string",
description
"comprobanteVenta":
acuseReciboItem 
0,
$ref:
 "
#/definitions/SDTNotificacionCooperativaResult.acuseRecibo" SDTNotificacionCooperativaResult.acuseRecibo: properties:
serieComprobanteVenta": "string",
idTransaccion:
"montoComprobanteVenta": 0,
description
"fechaComprobanteVenta":
id
"string",
Transaccion
type
"codigoAutorizacion": "
integer
string"
      }
format:
]
"int64"
  }
}

200 (Successful operation)

(Registro Creado con Éxito)

Code Block
languagejson
{
idTransaccionSifco
"result": {
    "idPrestador": 0,
description:
id
Transaccion
Sifco
"acuseRecibo": [
      {
type:
"string"
fechaOperacionPrestador:
"idTransaccion": 0,
description
"idTransaccionSifco":
fecha
"string",
Operacion
Prestador
type
"fechaOperacionPrestador": "string",
        "observacion": "string"
      }
description:
observacion
  ]
  }
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
type: 
"
string
error": {
x-gx-level
"code": "
SDTNotificacionCooperativaResult
string",
GxJsonError: properties: 
"message": "string"
error: $ref: "#/definitions/GxJsonError.error" GxJsonError.error: properties: code: description: Codigo 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" , "creditos" , "hub" , "notificacion" , "cooperativa" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History