Herramientas de usuario
¡Esta es una revisión vieja del documento!
Tabla de Contenidos
Fábrica - Servicios Web - Integraciones
Esta sección esta dedicada a los Servicios Web que proveen integraciones.
Documentos Relacionados
Para diligenciar la documentación de los servicios web se anexan las siguientes plantillas o procesos los cuales deben utilizarse como referencia:
| Fecha | Versión | Estado | Tipo | Proceso |
|---|---|---|---|---|
| 01/07/2021 | 1.0 | Vigente | Plantilla | Plantilla para diligenciamiento de Servicios Web |
| 22/03/2022 | 1.0 | Vigente | Documento | Despliegue Springboot |
| 22/03/2022 | 1.0 | Vigente | Documento | Consultar Javadoc |
| 22/03/2022 | 1.0 | Vigente | Documento | Consultar Swagger |
Listado de Servicios Web
| Nombre Servicio1) | Descripción2) | Versión3) | Fecha Release4) | Tecnología5) | Estado6) |
|---|---|---|---|---|---|
| WsCargarArchivos | Funcionalidad de carga de información de los ticket del otrs para la gestion de los mismos mediante una aplicacion de gerencia para realizar estadisticas y analisis internos. | 11.0.1.0 | 01/07/2021 | SpringBoot 4.4 | Activo |
| WsEfinominaCsj | Funcionalidad que consume los metodos expuestos por el web service del cliente Efinomina. | 11.0.1.0 | 01/07/2021 | SpringBoot 4.4 | Activo |
| WsPagoAutomatico | Funcionalidad que genera el pago automático de la Nomina y Seguridad Social, llenando las tablas actuales de nomina. | 11.0.1.0 | 01/07/2021 | SpringBoot 4.4 | Activo |
| WsLogs | Funcionalidad de este servicio es exponer microservicios para llevar registro de logs (transacción, error, sesión, carga de archivo). | 11.0.1.0 | 28/07/2021 | SpringBoot 4.4 | Activo |
| WebServiceRecaudoIFX | Servicio web de bancos para recaudo en línea del cliente Bello. | 1.0 | - | SOAP | Activo |
| WsPortal | Servicios del portal del contribuyente. | - | - | RESTFull | Activo |
| SicofMobileServiceADA | Servicios backend utilizados por la app de SICOF ERP. | 11.0.1.0 | 21/10/2021 | SpringBoot 2.5.5 | Activo |
| SicofWS | Servicios Web backend para la creación/actualización de terceros, creación facturas y recaudos | 8.0.1.0 | 19/11/2021 | SpringBoot 1.5.2 | Activo |
| MicroservicioConfigApp | Servicio que gestiona configuraciones y parámetros centralizados para aplicaciones. | 11.6.0.1 | 25/02/2022 | SpringBoot 2.6.3 | Activo |
| AdaEmailService | Servicio genérico de envío de correos. | 11.6.0.1 | 18/03/2022 | SpringBoot 2.6.4 | Activo |
| MicroservicioBloquearUsuariosInactivos | Servicio que gestiona el bloqueo de usuarios que no ingresan a SICOFERP por un determinado tiempo | 11.0.0.1 | 27/01/2022 | SpringBoot 2.6.3 | Activo |
| AdaDeploymentService | Servicio que realiza despliegues de aplicaciones Appeon/Powerbuilder | 11.0.0.1 | 04/04/2022 | SpringBoot 2.6.4 | Activo |
| SicofDownloadDocumentoDB | Servicio que Extrae archivos de documentos generados en los procesos de la DIAN (Factura Electrónica y Documento Soporte) | 1.0.0 | 01/06/2023 | SpringBoot 2.7.6 | Activo |
Testando Servicio con Postman (Web)
Ingrese a la url: https://identity.getpostman.com/login y digite las credenciales de acceso.
Tambien puede ingresar con una cuenta google:
Sera dirigido al dashboard de la cuenta
Antes de empezar a probar servicios debe crear un workspace asociado a la cuenta de ingreso
Posteriormente debe crear las colecciones que desee y adicionar las request de las operaciones que desea probar.
Notas de Despliegue
Compilar war
Para compilar un war ejecute el siguiente código en entorno maven (Ejemplo Eclipse, Springtools)
clean install -DskipTests
Compilar jar
Para compilar un jar ejecute el siguiente código en entorno maven (Ejemplo Eclipse, Springtools)
clean package -DskipTests
Desplegar war en Jboos/WildFly (Modo Directo)
- Acceder al servidor por winscp
- Ubicarse en el directorio deployments
- Si existe un despliegue previo (borrar el arcgivo war)
- Luego borrar el archivo de despliegue el cual es el mismo nombre del war con la extensión undeployed
- Copiar el nuevo war
- Por último revisar el log del servidor para ver si generó algún error y/o conocer el contexto de despliegue
Desplegar jar en Window
java -jar archivo.jar
Desplegar jar en Linux (en segundo plano)
nohup java -jar archivo.jar &
Utilerias Linux
Buscar jar desplegado: ps aux | grep java
Matar Proceso: sudo kill PID
Ecosistema de Servicios Web (Java 21 - Springboot 3.x)
A continuación se listan los nuevos servicios con la nueva tecnología java 21 con springboot 3.x
Ver Documentación
Para ver la documentación de cada microservicio se debe modificar en cada servicio el final del path base api/vx por el tipo de docuentación a visualizar. Tenga presente que la x indica la versión vigente.
Ejemplo: Ver Documentación OpenAPI Json
Para visualizar la documentación en formato json. Se debe reemplazar /api/v1 por /api-docs en la siguiente tabla se muestra cmabio a aplicar para ver la documentación.
| Url base | Url Documentación |
|---|---|
| http://10.1.140.21:9010/contratistas-solicitud/api/v1 | http://10.1.140.21:9010/contratistas-solicitud/api-docs |
Se debe copiar el texto generado7), abrir la url del visor swagger https://editor.swagger.io/ y reemplazar todo el contenido de la sección izquierda. A la derecha visualizará la documentación dle microservicio.
Nota: v1 indica la versión vigente.
Ejemplo: Ver Documentación en el visor Swagger integrado
Para visualizar la documentación en el visor swagger integrado. Se debe reemplazar /api/v1 por /swagger-ui/index.html en la siguiente tabla se muestra cmabio a aplicar para ver la documentación.
| Url base | Url Documentación |
|---|---|
| http://10.1.140.21:9010/contratistas-solicitud/api/v1 | http://10.1.140.21:9010/contratistas-solicitud/swagger-ui/index.html |
Nota: v1 indica la versión vigente.
Herramientas de la página
