Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Web Services para Notificación Cooperativa a HUB de Créditos.
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ónDESCRIPCIÓ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: "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"
url: "https://sifco.atlassian.net/wiki/x/mAWo"
produces:
- application/json
paths:
/API/HUB/V1/NotificacionCooperativa:
post:
tags:
- API.HUB.V1.NotificacionCooperativa
operationId: "API.HUB.V1.NotificacionCooperativa"
summary: "Notificacion Cooperativa a 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: "NotificacionCooperativaInput"
in: "body"
required: false
schema:
$ref: "#/definitions/API.HUB.V1.NotificacionCooperativaInput"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/API.HUB.V1.NotificacionCooperativaOutput"
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 metodo 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.NotificacionCooperativaInput:
properties:
data:
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 Transacción
type: "integer"
format: "int64"
idTransaccionSifco:
description: id Transacció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 Operación Negocio
type: "string"
idRelacionPN:
description: id Relación PN
type: "integer"
format: "int64"
idRelacionTP:
description: id Relació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: "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:
HEADERS
BODY:
| |||||||||||||||
200 (Successful operation) (Registro Creado con Éxito) |
| |||||||||||||||
400 (Bad Request). Solicitud Errada |
| |||||||||||||||
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) ). |
| |||||||||||||||
404 (Not Found). | Respuesta Vacía (Web Service, no encontrado) | |||||||||||||||
500 (Internal Server Error) (Error Interno del Servidor de las API’s REST). |
|
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 | ||
---|---|---|
| ||
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||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Artículos Relacionados
| ||||||||||||
Artículos Actualizados Recientemente
| ||||||||||||
|