Muestra las diferencias entre dos versiones de la página.
Próxima revisión | Revisión previa | ||
ada:howto:sicoferp:factory:integrations:portal.contribuyente:ws [2021/09/01 18:03] 192.168.177.37 creado |
ada:howto:sicoferp:factory:integrations:portal.contribuyente:ws [2021/09/01 19:41] (actual) 192.168.177.37 |
||
---|---|---|---|
Línea 1: | Línea 1: | ||
- | ====== Fábrica - Integraciones - Servicios Web - Portal Contribuyente - administracionws ====== | + | ====== Fábrica - Integraciones - Servicios Web - Portal Contribuyente ====== |
- | 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. | + | Servicio transaccional para el manejo de consultas, usuarios, parámetros, etc. del Portal del Contribuyente. |
===== Descripción del Servicio ===== | ===== Descripción del Servicio ===== | ||
Línea 17: | Línea 17: | ||
^Operaciones^^^^^^^^ | ^Operaciones^^^^^^^^ | ||
^Tipo Petición Http^Nombre operación^^Descripción^^^Documentación^^ | ^Tipo Petición Http^Nombre operación^^Descripción^^^Documentación^^ | ||
- | |POST| /transactional/save||Se encarga de guardar el registro de una transacción.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |GET| /administracionws/consulta/parametros/todos/ ||Se encarga de la consulta de los parámetros del sismtema.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| |
- | |GET| /transactional/getRegisters||Se encarga de obtener registros según el parámetro enviado.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |GET| /administracionws/consulta/aplicaciones/todos/ ||Se encarga de la consulta de las aplicaciones del sistema.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| |
- | |GET| /transactional/{id}/getRegister ||Se encarga de obtener un registro por ID.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |GET| /administracionws/consulta/usuarios/todos/ ||Se encarga de la consulta de los usuarios del sistema.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| |
- | |POST| /session/save||Se encarga de guardar el registro de una sesión.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |GET| /portalws/login/ || Servicio para el inicio de sesión del usuario.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| |
- | |GET| /session/getRegisters||Se encarga de obtener registros según el parámetro enviado.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |POST| /portalws/factura/ ||Servicio para la consulta de las facturas activas o pagadas el usuario.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| |
- | |GET| /session/{id}/getRegister ||Se encarga de obtener un registro por ID.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |POST| /portalws/acuerdos/ ||Servicio para la consulta de los acuerdos de pagos del usuario.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| |
- | |PUT| /session/{id} || Se encarga de actualizar un registro por ID, para cuando se realiza un finalizar sesión.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |GET| /portalws/descargar/{authorization}/{authorization2}/{fuente}/{tipo_doc} || Servicio para la descarga de documentos en formato PDF (facturas y paz y salvos).|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| |
- | |POST| /upload/save||Se encarga de guardar el registro al realizar una subida de archivo.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |GET| /portalws/seguridad/cambio/solicitud/||Servicio para el envió del correo con el token para el cambio de contraseña.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| |
- | |GET| /upload/getRegisters||Se encarga de obtener registros según el parámetro enviado.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |GET| /portalws/seguridad/cambio/completar/||Servicio para confirmar el cambio de contraseña.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| |
- | |POST| /error/save||Se encarga de guardar el registro de error.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |
- | |GET| /error/getRegisters||Se encarga de obtener registros según el parámetro enviado.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |
- | |GET| /error/{id}/getRegister ||Se encarga de obtener un registro por ID.|||[[#Contrato de Servicio|Ver Contrato de Servicio]]|| | + | |
Línea 55: | Línea 52: | ||
servers: | servers: | ||
- url: //10.1.140.1:42002/ | - url: //10.1.140.1:42002/ | ||
+ | - url: //srv-app-dev-01-wf03.adacsc.co/ | ||
tags: | tags: | ||
- name: administracion-ws | - name: administracion-ws | ||
Línea 880: | Línea 878: | ||
error: | error: | ||
type: boolean | type: boolean | ||
- | description: Indica si hubo un error en el procesamiento de la solicitud del usuario | + | description: >- |
+ | Indica si hubo un error en el procesamiento de la solicitud del | ||
+ | usuario | ||
codigoMensaje: | codigoMensaje: | ||
type: string | type: string | ||
Línea 886: | Línea 886: | ||
mensaje: | mensaje: | ||
type: string | type: string | ||
- | description: Mensaje generado para informar al usuario la respuesta de su petición | + | description: >- |
+ | Mensaje generado para informar al usuario la respuesta de su | ||
+ | petición | ||
mensajeTecnico: | mensajeTecnico: | ||
type: string | type: string | ||
- | description: Mensaje técnico con el eventual error presentado generado para informar al cliente consumidor del servicio | + | 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) | + | description: >- |
+ | Total registros devueltos en el primer arreglo de la respuesta | ||
+ | (payload) | ||
</code> | </code> | ||