Servicio transaccional para el manejo de usuarios, parámetros, etc. del Portal del Contribuyente. Este Servicio debe estar alojado en la red interna, no debe ser expuesto a internet.

A continuación se presenta el contrato de servicio con las operaciones implementadas. La documentación está realizada en el estandar OpenAPI V3.0.1. Para visualizar la documentación (Vista html) copie el código Yaml en un visor Swagger.

openapi: 3.0.1
info:
  title: Servicio Portal del Contribuyente
  contact:
    name: ADA.S.A
    url: https://ada.co/
    email: info@ada.co
  license:
    name: Apache License Version 2.0
  version: '1.0'
servers:
  - url: //10.1.140.1:42002/
tags:
  - name: administracion-ws
    description: Gestor de usuarios y parámetros
  - name: portal-ws
    description: Gestor core del portal, sesiones, consultas, pagos en línea
  - name: notificacion-ws
    description: Gestor de transacciones masivas entre el cliente y el portal
  - name: registro-ws
    description: Gestor del registro de usuarios al sistema
paths:
  /administracionws/consulta/parametros/todos/:
    get:
      tags:
        - administracion-ws
      summary: obtenerListadoParametros
      operationId: obtenerListadoParametrosGET
      parameters:
        - name: Authorization
          in: header
          description: token de la aplicación
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Parametros'
        '204':
          description: NoContent
          content: {}
        '401':
          description: Unauthorized
          content: {}
        '403':
          description: Forbidden
          content: {}
        '500':
          description: Internal Server Error
          content: {}
  /administracionws/consulta/aplicaciones/todos/:
    get:
      tags:
        - administracion-ws
      summary: obtenerListadoAplicaciones
      operationId: obtenerListadoAplicacionesGET
      parameters:
        - name: Authorization
          in: header
          description: token de la aplicación
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Aplicaciones'
        '204':
          description: NoContent
          content: {}
        '401':
          description: Unauthorized
          content: {}
        '403':
          description: Forbidden
          content: {}
        '500':
          description: Internal Server Error
          content: {}
  /administracionws/consulta/usuarios/todos/:
    get:
      tags:
        - administracion-ws
      summary: obtenerListadoUsuarios
      operationId: obtenerListadoUsuariosGET
      parameters:
        - name: Authorization
          in: header
          description: token de la aplicación
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Usuarios'
        '204':
          description: NoContent
          content: {}
        '401':
          description: Unauthorized
          content: {}
        '403':
          description: Forbidden
          content: {}
        '500':
          description: Internal Server Error
          content: {}
  /portalws/login/:
    get:
      tags:
        - portal-ws
      summary: login
      operationId: loginGET
      parameters:
        - name: Authorization
          in: header
          description: Nombre del path del cliente, según el valor en la tabla aplicacion
          schema:
            type: string
        - name: usuario
          in: header
          description: Cuenta de correo del usuario o nickname
          schema:
            type: string
        - name: password
          in: header
          description: Contraseña de la cuenta de usuario
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            authorization:
              description: Token de sesión del usuario
              schema:
                type: string
            authorization_app:
              description: Token de la aplicación asociada al path recibido en el request
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EstadoTransaccion'
        '403':
          description: Forbidden
          content: {}
        '500':
          description: Internal Server Error
          content: {}
components:
  schemas:
    Parametros:
      title: Parametros
      type: object
      properties:
        error:
          type: boolean
        codigoMensaje:
          type: string
        mensaje:
          type: string
        totalRegistros:
          type: integer
        payload:
          type: array
          items:
            $ref: '#/components/schemas/Parametro'
    Aplicaciones:
      title: Aplicaciones
      type: object
      properties:
        error:
          type: boolean
        codigoMensaje:
          type: string
        mensaje:
          type: string
        totalRegistros:
          type: integer
        payload:
          type: array
          items:
            $ref: '#/components/schemas/Aplicacion'
    Usuarios:
      title: Usuarios
      type: object
      properties:
        error:
          type: boolean
        codigoMensaje:
          type: string
        mensaje:
          type: string
        totalRegistros:
          type: integer
        payload:
          type: array
          items:
            $ref: '#/components/schemas/Usuario'
    Parametro:
      title: Parametro
      type: object
      properties:
        id:
          type: integer
          format: int64
        nombre:
          type: string
          format: int64
        tipo:
          type: string
        valor:
          type: string
        descripcion:
          type: string
          format: int64
        idAplicacion:
          type: integer
          format: int64
    Aplicacion:
      title: Aplicacion
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Identificador del registro
        nombre:
          type: string
          description: Nombre de la aplicación o cliente
        token:
          type: string
        fechaVigencia:
          type: string
          format: date
          description: Fecha hasta la que estará vigente el acceso del cliente al portal
        esInterna:
          type: string
          description: Indica si la aplicación es interna o del sistema S o es un cliente N
        estado:
          type: string
          description: >-
            Indica el estado de la aplicación A, I o S (Activa, Inactiva o
            Suspendida)
    Usuario:
      title: Usuario
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Identificador del registro
        numeroDocumento:
          type: string
          description: Número de documento del usuario
        nombre:
          type: string
          description: Nombre del usuario
        correoElectronico:
          type: string
          description: Correo electrónico del usuario. Nickname de la cuenta de usuario
        direccion:
          type: string
          description: Dirección física del usuario
        telefono:
          type: string
          description: Número telefónico principal del usuario
        telefonoAlterno:
          type: string
          description: Número telefónico alterno del usuario
        token:
          type: string
        ultimoIngreso:
          type: string
          format: date-time
          description: Fecha del último ingreso del usuario al sistema
        tokenVigencia:
          type: string
          format: date-time
          description: Fecha de vigencia del token de sesión
        aceptaNotificacionElectronica:
          type: boolean
          description: Indica si el usuario recibe notificaciones elctrónicas
        estado:
          type: string
          description: Indica el estado del usuario P, *, -, M, D, I, A, S, Z, R, V, O, B
    EstadoTransaccion:
      title: EstadoTransaccion
      type: object
      properties:
        error:
          type: boolean
        codigoMensaje:
          type: string
        mensaje:
          type: string
        totalRegistros:
          type: integer

←Volver atrás