Herramientas de usuario

Herramientas del sitio


ada:howto:sicoferp:factory:integrations:portal.contribuyente:administracionws

Diferencias

Muestra las diferencias entre dos versiones de la página.

Enlace a la vista de comparación

Ambos lados, revisión anterior Revisión previa
ada:howto:sicoferp:factory:integrations:portal.contribuyente:administracionws [2021/09/01 16:07]
192.168.177.37
ada:howto:sicoferp:factory:integrations:portal.contribuyente:administracionws [2021/09/01 17:56] (actual)
192.168.177.37
Línea 72: Línea 72:
       operationId:​ obtenerListadoParametrosGET       operationId:​ obtenerListadoParametrosGET
       parameters:       parameters:
-        - name: Authorization+        - name: authorization
           in: header           in: header
 +          required: true
           description:​ token de la aplicación           description:​ token de la aplicación
           schema:           schema:
Línea 88: Línea 89:
         '​204':​         '​204':​
           description:​ NoContent           description:​ NoContent
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​401':​         '​401':​
           description:​ Unauthorized           description:​ Unauthorized
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​403':​         '​403':​
           description:​ Forbidden           description:​ Forbidden
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​500':​         '​500':​
           description:​ Internal Server Error           description:​ Internal Server Error
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
   /​administracionws/​consulta/​aplicaciones/​todos/:​   /​administracionws/​consulta/​aplicaciones/​todos/:​
     get:     get:
Línea 105: Línea 118:
       operationId:​ obtenerListadoAplicacionesGET       operationId:​ obtenerListadoAplicacionesGET
       parameters:       parameters:
-        - name: Authorization+        - name: authorization
           in: header           in: header
 +          required: true
           description:​ token de la aplicación           description:​ token de la aplicación
           schema:           schema:
Línea 121: Línea 135:
         '​204':​         '​204':​
           description:​ NoContent           description:​ NoContent
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​401':​         '​401':​
           description:​ Unauthorized           description:​ Unauthorized
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​403':​         '​403':​
           description:​ Forbidden           description:​ Forbidden
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​500':​         '​500':​
           description:​ Internal Server Error           description:​ Internal Server Error
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
   /​administracionws/​consulta/​usuarios/​todos/:​   /​administracionws/​consulta/​usuarios/​todos/:​
     get:     get:
Línea 138: Línea 164:
       operationId:​ obtenerListadoUsuariosGET       operationId:​ obtenerListadoUsuariosGET
       parameters:       parameters:
-        - name: Authorization+        - name: authorization
           in: header           in: header
 +          required: true
           description:​ token de la aplicación           description:​ token de la aplicación
           schema:           schema:
Línea 154: Línea 181:
         '​204':​         '​204':​
           description:​ NoContent           description:​ NoContent
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​401':​         '​401':​
           description:​ Unauthorized           description:​ Unauthorized
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​403':​         '​403':​
           description:​ Forbidden           description:​ Forbidden
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​500':​         '​500':​
           description:​ Internal Server Error           description:​ Internal Server Error
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
   /​portalws/​login/:​   /​portalws/​login/:​
     get:     get:
Línea 171: Línea 210:
       operationId:​ loginGET       operationId:​ loginGET
       parameters:       parameters:
-        - name: Authorization+        - name: authorization
           in: header           in: header
 +          required: true
           description:​ Nombre del path del cliente, según el valor en la tabla aplicacion           description:​ Nombre del path del cliente, según el valor en la tabla aplicacion
           schema:           schema:
Línea 178: Línea 218:
         - name: usuario         - name: usuario
           in: header           in: header
 +          required: true
           description:​ Cuenta de correo del usuario o nickname           description:​ Cuenta de correo del usuario o nickname
           schema:           schema:
Línea 183: Línea 224:
         - name: password         - name: password
           in: header           in: header
 +          required: true
           description:​ Contraseña de la cuenta de usuario           description:​ Contraseña de la cuenta de usuario
           schema:           schema:
Línea 196: Línea 238:
             authorization_app:​             authorization_app:​
               description:​ Token de la aplicación asociada al path recibido en el request               description:​ Token de la aplicación asociada al path recibido en el request
 +              schema:
 +                type: string
 +          content:
 +            application/​json:​
 +              schema:
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
 +        '​403':​
 +          description:​ Forbidden
 +          content:
 +            application/​json:​
 +              schema:
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
 +        '​500':​
 +          description:​ Internal Server Error
 +          content:
 +            application/​json:​
 +              schema:
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
 +  /​portalws/​factura/:​
 +    post:
 +      tags:
 +        - portal-ws
 +      summary: consultaFacturasPortalContribuyente
 +      operationId:​ consultaFacturasPortalContribuyentePOST
 +      requestBody:​
 +        description:​ Parámetros de consulta
 +        content:
 +          application/​json:​
 +            schema:
 +              $ref: '#/​components/​schemas/​ConsultaInformacion'​
 +      parameters:
 +        - name: authorization
 +          in: header
 +          required: true
 +          description:​ Token de aplicacion
 +          schema:
 +            type: string
 +      responses:
 +        '​200':​
 +          description:​ OK
 +          headers:
 +            authorization:​
 +              description:​ Token de sesión del usuario
               schema:               schema:
                 type: string                 type: string
Línea 203: Línea 288:
                 type: array                 type: array
                 items:                 items:
-                  $ref: '#/​components/​schemas/​EstadoTransaccion'​+                  ​$ref: '#/​components/​schemas/​TipoNotificacionRespuestas'​ 
 +        '​204':​ 
 +          description:​ No Content 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                ​$ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​403':​         '​403':​
           description:​ Forbidden           description:​ Forbidden
-          content: ​{}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
         '​500':​         '​500':​
           description:​ Internal Server Error           description:​ Internal Server Error
-          content: {}+          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +  /​portalws/​acuerdos/:​ 
 +    post: 
 +      tags: 
 +        - portal-ws 
 +      summary: consultaAcuerdosPortalContribuyente 
 +      operationId:​ consultaAcuerdosPortalContribuyentePOST 
 +      requestBody:​ 
 +        description:​ Parámetros de consulta 
 +        content: 
 +          application/​json:​ 
 +            schema: 
 +              $ref: '#/​components/​schemas/​ConsultaInformacion'​ 
 +      parameters:​ 
 +        - name: authorization 
 +          in: header 
 +          required: true 
 +          description:​ Token de aplicacion 
 +          schema: 
 +            type: string 
 +      responses:​ 
 +        '​200':​ 
 +          description:​ OK 
 +          headers: 
 +            authorization:​ 
 +              description:​ Token de sesión del usuario renovado 
 +              schema: 
 +                type: string 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                type: array 
 +                items: 
 +                  $ref: '#/​components/​schemas/​TipoNotificacionRespuestas'​ 
 +        '​204':​ 
 +          description:​ No Content 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​403':​ 
 +          description:​ Forbidden 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​500':​ 
 +          description:​ Internal Server Error 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +  /​portalws/​descargar/​{authorization}/​{authorization2}/​{fuente}/​{tipo_doc}:​ 
 +    get: 
 +      tags: 
 +        - portal-ws 
 +      summary: descargarDocumento 
 +      operationId:​ descargarDocumentoGET 
 +      parameters:​ 
 +        - name: authorization 
 +          in: path 
 +          required: true 
 +          description:​ token de sesión de usuario 
 +          schema: 
 +            type: string 
 +        - name: authorization2 
 +          in: path 
 +          required: true 
 +          description:​ token de único del documento 
 +          schema: 
 +            type: string 
 +        - name: fuente 
 +          in: path 
 +          required: true 
 +          description:​ token de único del documento 
 +          schema: 
 +            type: string 
 +        - name: tipo_doc 
 +          in: path 
 +          required: true 
 +          description:​ >- 
 +            Indica si el documento es un paz y salvo (pyz) o un documento de 
 +            cobro (fact) 
 +          schema: 
 +            type: string 
 +      responses:​ 
 +        '​200':​ 
 +          description:​ OK 
 +          headers: 
 +            authorization:​ 
 +              description:​ Token de sesión del usuario renovado 
 +              schema: 
 +                type: string 
 +          content: 
 +            application/​pdf:​ 
 +              schema: 
 +                type: object 
 +        '​204':​ 
 +          description:​ NoContent 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​403':​ 
 +          description:​ Forbidden 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​500':​ 
 +          description:​ Internal Server Error 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +  /​portalws/​seguridad/​cambio/​solicitud/:​ 
 +    get: 
 +      tags: 
 +        - portal-ws 
 +      summary: solicitarCambiarContrasenia 
 +      operationId:​ solicitarCambiarContraseniaGET 
 +      parameters:​ 
 +        - name: authorization 
 +          in: header 
 +          required: true 
 +          description:​ token de sesión de usuario 
 +          schema: 
 +            type: string 
 +        - name: usuario 
 +          in: header 
 +          required: true 
 +          description:​ correo electrónico o nickname 
 +          schema: 
 +            type: string 
 +      responses:​ 
 +        '​200':​ 
 +          description:​ OK 
 +          headers: 
 +            authorization:​ 
 +              description:​ Token de sesión del usuario renovado 
 +              schema: 
 +                type: string 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​204':​ 
 +          description:​ NoContent 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​403':​ 
 +          description:​ Forbidden 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​500':​ 
 +          description:​ Internal Server Error 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +  /​portalws/​seguridad/​cambio/​completar/:​ 
 +    get: 
 +      tags: 
 +        - portal-ws 
 +      summary: cambiarContrasenia 
 +      operationId:​ cambiarContraseniaGET 
 +      parameters:​ 
 +        - name: authorization 
 +          in: header 
 +          required: true 
 +          description:​ token de sesión de usuario 
 +          schema: 
 +            type: string 
 +        - name: password 
 +          in: header 
 +          required: true 
 +          description:​ nuevo password 
 +          schema: 
 +            type: string 
 +      responses:​ 
 +        '​200':​ 
 +          description:​ OK 
 +          headers: 
 +            authorization:​ 
 +              description:​ Token de sesión del usuario renovado 
 +              schema: 
 +                type: string 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​204':​ 
 +          description:​ NoContent 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​403':​ 
 +          description:​ Forbidden 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​ 
 +        '​500':​ 
 +          description:​ Internal Server Error 
 +          content: 
 +            application/​json:​ 
 +              schema: 
 +                $ref: '#/​components/​schemas/​EstadoTransaccion'​
 components: components:
   schemas:   schemas:
Línea 260: Línea 569:
           items:           items:
             $ref: '#/​components/​schemas/​Usuario'​             $ref: '#/​components/​schemas/​Usuario'​
 +    TipoNotificacionRespuestas:​
 +      title: TipoNotificacionRespuestas
 +      type: object
 +      properties:
 +        error:
 +          type: boolean
 +        codigoMensaje:​
 +          type: string
 +        mensaje:
 +          type: string
 +        totalRegistros:​
 +          type: integer
 +        payload:
 +          type: array
 +          items:
 +            $ref: '#/​components/​schemas/​TipoNotificacionRespuesta'​
     Parametro:     Parametro:
       title: Parametro       title: Parametro
Línea 267: Línea 592:
           type: integer           type: integer
           format: int64           format: int64
 +          description:​ Identificador del registro
         nombre:         nombre:
           type: string           type: string
-          ​formatint64+          ​descriptionNombre del parámetro
         tipo:         tipo:
           type: string           type: string
 +          description:​ Tipo de parámetro
         valor:         valor:
           type: string           type: string
 +          description:​ Valor del parámetro
         descripcion:​         descripcion:​
           type: string           type: string
-          ​formatint64+          ​descriptionDescripción del parámetro
         idAplicacion:​         idAplicacion:​
           type: integer           type: integer
           format: int64           format: int64
 +          description:​ Identificador de la aplicación propietaria del parámetro
     Aplicacion:     Aplicacion:
       title: Aplicacion       title: Aplicacion
Línea 347: Línea 676:
           type: string           type: string
           description:​ Indica el estado del usuario P, *, -, M, D, I, A, S, Z, R, V, O, B           description:​ Indica el estado del usuario P, *, -, M, D, I, A, S, Z, R, V, O, B
 +    TipoNotificacionRespuesta:​
 +      title: TipoNotificacionRespuesta
 +      type: object
 +      properties:
 +        id:
 +          type: integer
 +          format: int64
 +          description:​ Identificador del registro
 +        urlPago:
 +          type: string
 +          format: url
 +          description:​ URL de la pasarela de pagos en línea
 +        respuestas:
 +          type: array
 +          items:
 +            $ref: '#/​components/​schemas/​ConsultaInformacionRespuesta'​
 +    ConsultaInformacionRespuesta:​
 +      title: ConsultaInformacionRespuesta
 +      type: object
 +      properties:
 +        id:
 +          type: integer
 +          format: int64
 +          description:​ Identificador del registro
 +        consecutivo:​
 +          type: integer
 +          format: int64
 +          description:​ Consecutivo del documento de cobro
 +        idDocumento:​
 +          type: integer
 +          format: int64
 +          description:​ Identificador del documento de cobro (id factura)
 +        idTipoNotificacion:​
 +          type: integer
 +          format: int64
 +          description:​ Identificador del tipo de documento
 +        idFormaPago:​
 +          type: integer
 +          format: int64
 +          description:​ Identificador de la forma de pago
 +        formaPago:
 +          type: string
 +          description:​ Forma de pago
 +        valor:
 +          type: integer
 +          format: int64
 +          description:​ Valor del documento de cobro
 +        fechaElaboracion:​
 +          type: string
 +          format: date
 +          description:​ Fecha de elaboración del documento de cobro
 +        fechaVencimiento:​
 +          type: string
 +          format: date
 +          description:​ Fecha de vencimiento del documento de cobro
 +        token:
 +          type: string
 +          description:​ Token generado para la identificación segura del documento
 +        objeto:
 +          type: string
 +          description:​ >-
 +            Identificador del objeto conocido por el usuario (cédula catastral,
 +            placa, línea teleónica, etc.)
 +        estado:
 +          type: string
 +          description:​ Estado del documento de cobro (cancelado, pendiente de pago, etc.)
 +        vigencia:
 +          type: string
 +          description:​ Vigencia del documento de cobro, formato yyyy
 +        icono:
 +          type: string
 +          description:​ Imagen o ícono que representa el tipo de documento
 +        tipo:
 +          type: string
 +          description:​ >-
 +            Descripción del tipo de documento (Vehículo particula, Lote,
 +            Discoteca, etc.)
 +        datoAdicional:​
 +          type: string
 +          description:​ Información adicional del objeto. Dirección, referencias,​ etc
 +        urlPago:
 +          type: string
 +          description:​ URL de pago única para este documento de cobro en referencia.
 +        urlDocumento:​
 +          type: string
 +          description:​ URL para descargar el documento de cobro.
 +        urlPazYSalvo:​
 +          type: string
 +          description:​ URL para descargar el documento de paz y salvo.
 +        urlResolucion:​
 +          type: string
 +          description:​ >-
 +            URL para descargar el documento de resolución asociado a la
 +            facturación del periodo.
 +        idPazYSalvo:​
 +          type: integer
 +          format: int64
 +          description:​ Identificador del documento de paz y salvo
 +        deudaTotal:
 +          type: integer
 +          format: int64
 +          description:​ Valor de la deuda total (Aplica para acuerdos de pago)
 +        valorPagado:​
 +          type: integer
 +          format: int64
 +          description:​ Valor total de los pagos anteriores (Aplica para acuerdos de pago)
 +        deudaActual:​
 +          type: integer
 +          format: int64
 +          description:​ Deuda total actual (Aplica para acuerdos de pago)
 +        proximoPago:​
 +          type: integer
 +          format: int64
 +          description:​ Valor total de los próximos pagos (Aplica para acuerdos de pago)
 +        pagos:
 +          type: array
 +          items:
 +            $ref: '#/​components/​schemas/​ConsultaInformacionRespuestaPagos'​
 +          description:​ Listado de pagos aplicados (Aplica para acuerdos de pago)
 +        pendientes:
 +          type: array
 +          items:
 +            $ref: '#/​components/​schemas/​ConsultaInformacionRespuestaPendiente'​
 +          description:​ Listado de cuotas pendientes (Aplica para acuerdos de pago)
 +    ConsultaInformacionRespuestaPagos:​
 +      title: ConsultaInformacionRespuestaPagos
 +      type: object
 +      properties:
 +        id:
 +          type: integer
 +          format: int64
 +          description:​ Identificador del registro
 +        idCuota:
 +          type: integer
 +          format: int64
 +          description:​ Número de cuota (1, 2, 3, etc.)
 +        referencia:
 +          type: integer
 +          format: int64
 +          description:​ Referencia de pago (comprobante de ingreso)
 +        fechaPago:
 +          type: string
 +          format: date
 +          description:​ Fecha en que se aplicó el pago
 +        valor:
 +          type: integer
 +          format: int64
 +          description:​ Valor pagado
 +    ConsultaInformacionRespuestaPendiente:​
 +      title: ConsultaInformacionRespuestaPendiente
 +      type: object
 +      properties:
 +        id:
 +          type: integer
 +          format: int64
 +          description:​ Identificador del registro
 +        idCuota:
 +          type: integer
 +          format: int64
 +          description:​ Número de cuota (1, 2, 3, etc.)
 +        fechaVencimiento:​
 +          type: string
 +          format: date
 +          description:​ Fecha de vencimiento de la cuota
 +        valor:
 +          type: integer
 +          format: int64
 +          description:​ Valor por pagar
 +        deudaTotal:
 +          type: integer
 +          format: int64
 +          description:​ Deuda total al momento de la cuota
 +        valorPagado:​
 +          type: integer
 +          format: int64
 +          description:​ Valor pagado al momento de la cuota
 +        deudaActual:​
 +          type: integer
 +          format: int64
 +          description:​ Deuda actual al momento de la cuota
 +        proximoPago:​
 +          type: integer
 +          format: int64
 +          description:​ Valor próximos pagos al momento de la cuota
 +    ConsultaInformacion:​
 +      title: ConsultaInformacion
 +      type: object
 +      properties:
 +        estado:
 +          type: string
 +          description:​ Estado del documento de cobro. Se aceptan sólo dos estados P o C
 +        numeroDocumento:​
 +          type: string
 +          description:​ Número de documento del usuario
 +        vigencia:
 +          type: integer
 +          format: int64
 +          description:​ Vigencia del documento de cobro
     EstadoTransaccion:​     EstadoTransaccion:​
       title: EstadoTransaccion       title: EstadoTransaccion
Línea 353: Línea 880:
         error:         error:
           type: boolean           type: boolean
 +          description:​ Indica si hubo un error en el procesamiento de la solicitud del usuario
         codigoMensaje:​         codigoMensaje:​
           type: string           type: string
 +          description:​ Código HTML que se generó para la respuesta de la petición
         mensaje:         mensaje:
           type: string           type: string
 +          description:​ Mensaje generado para informar al usuario la respuesta de su petición
 +        mensajeTecnico:​
 +          type: string
 +          description:​ Mensaje técnico con el eventual error presentado generado para informar al cliente consumidor del servicio
         totalRegistros:​         totalRegistros:​
           type: integer           type: integer
 +          description:​ Total registros devueltos en el primer arreglo de la respuesta (payload)
 </​code>​ </​code>​
  
ada/howto/sicoferp/factory/integrations/portal.contribuyente/administracionws.1630512429.txt.gz · Última modificación: 2021/09/01 16:07 por 192.168.177.37