Web Services para Registrar Documentos de HUB de Créditos.

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**, como es Registrar Documentos 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.RegistrarDocumentosCreditoHub"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/Ewao"
produces:
  - application/json
paths:
  /API/HUB/V1/RegistrarDocumentosCreditoHub:
    post:
      tags:
        - API.HUB.V1.RegistrarDocumentosCreditoHub
      operationId: "API.HUB.V1.RegistrarDocumentosCreditoHub"
      summary: "Registrar Documentos 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: "RegistrarDocumentosCreditoHubInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/API.HUB.V1.RegistrarDocumentosCreditoHubInput"

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

        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.RegistrarDocumentosCreditoHubInput:
    properties:
      data:
        description: SDTRegistrar Documentos Credito
        $ref: "#/definitions/SDTRegistrarDocumentosCredito"

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

      idHub:
        description: id Hub
        type: "string"

      documentos:
        type: array
        items:
          description: documentosItem
          $ref: "#/definitions/SDTRegistrarDocumentosCredito.documentos"
  
  SDTRegistrarDocumentosCredito.documentos:
    properties:
      idDocumento:
        description: id Documento
        type: "integer"
        format: "int64"

      nombreDocumento:
        description: nombre Documento
        type: "string"

      urlPlantilla:
        description: url Plantilla
        type: "string"

      urlFirmados:
        description: url Firmados
        type: "string"

      estadoDocumento:
        description: estado Documento
        type: "string"


    x-gx-level: "SDTRegistrarDocumentosCredito"
  
  API.HUB.V1.RegistrarDocumentosCreditoHubOutput:
    properties:
      result:
        description: SDTRegistrar Documentos Credito Result
        $ref: "#/definitions/SDTRegistrarDocumentosCreditoResult"
  
  SDTRegistrarDocumentosCreditoResult:
    properties:
      idTransaccionSifco:
        description: id Transacción Sifco
        type: "string"

      mensajes:
        type: array
        items:
          description: mensajesItem
          $ref: "#/definitions/SDTRegistrarDocumentosCreditoResult.mensajes"


  SDTRegistrarDocumentosCreditoResult.mensajes:
    properties:
      codigoRespuesta:
        description: código Respuesta
        type: "integer"
        format: "int32"

      mensaje:
        description: mensaje
        type: "string"


    x-gx-level: "SDTRegistrarDocumentosCreditoResult"

  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"

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application

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.