====== Fábrica - Servicios Web - Integraciones - SicofDownloadDocumentDB ====== Este servicio permite descargar los documento electrónicos generado en los procesos de la DIAN (Factura electrónica y Documento Soporte). ===== Consideraciones Importantes ===== Inicialmente la solución se libera Sólo para el cliente Multiempresa Fosemed. ===== Descripción del Servicio ===== ^Nombre^Descripción^Tipo Servicio^Tecnología^Lenguaje^Tipo Desarrollo^Versión Desarrollo^Archivo de Configuración^ |SicofDownloadDocumentDB|Descarga documentos electrónicos.|Rest|SpringBoot 2.7.6|Java 11.0.2|Nuevo|1.0.0|application.properties| ^Tipo Empaquetado^Gestor de Dependencias^Servidor de Despliegue^IDE Proyecto^Tipo Repositorio^Url Desarrollo^Url Calidad^Url Producción^ |war|Maven 3.8.1|WildFly 20|SpringTools 4.18|Subversión|[[http://adacsc.co:1443/svn/repository/ADA/SICOF/Integraciones/FacturaElectronica/SicofDownloadDocumentDB |SVN branches]]|[[|SVN trunk]]|[[|SVN tags]]| ^Dependencias^^^^^^^^ ^groupId^artifactId^^version^scope^optional^Descripción^^ |org.springframework.boot|spring-boot-starter-data-rest||N/A|N/A|N/A|API de mapeo de rutas|| |org.springframework.boot|spring-boot-starter-web||N/A|N/A|N/A|Core Servicios Web|| |org.springframework.boot|spring-boot-devtools||N/A|runtime|true|Recarga de aplicaciones|| |org.projectlombok|lombok||N/A|N/A|true|API de anotaciones para reducción de código|| |org.springframework.boot|spring-boot-starter-test||N/A|test|N/A|Core Springboot|| |org.postgresql|webjars-locator-jboss-vfs||0.1.0|N/A|N/A|Plugins para despliegue en Wildfly|| |org.springframework.boot|spring-boot-starter-tomcat||N/A|provided|N/A|Servidor Embebido Tomcat|| |org.apache.maven.plugins|maven-compiler-plugin||3.8.1|N/A|N/A|Gestor de dependencias|| |org.springdoc|springdoc-openapi-ui||1.6.0|N/A|N/A|Plugins para generar documentación Swagger|| |org.springframework.boot|spring-boot-starter||N/A|N/A|N/A|Core Springboot|| ^Documentación Operaciones^^^^^^^^ ^Tipo^Documentación^^^^^^Visor^ |Swagger|[[http://10.1.20.84:3131/SicofDownloadDocumentDB/v3/api-docs|Ver Documento Json]]||||||https://editor.swagger.io/| |Javadoc|[[http://adacsc.co:1443/svn/repository/ADA/SICOF/Integraciones/FacturaElectronica/SicofDownloadDocumentDB /doc|Directorio Javadoc]]||||||Navegador Web| ^Ambientes de Despliegue^^^^^^^^ ^Tipo^Url^^Observaciones^^^^^ |Desarrollo:|http://localhost:8088||Ambiente de desarrollo||||| |Calidad:|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/||Ambiente de validación||||| |Producción:| ||Ambiente de producción||||| ===== Información Adicional ===== ===== Despliegue ===== ==== Requisitos Técnicos Servidor ==== * Servidor Wildlfy 20 o superior * Java 11 o OpenJDK 11 * S.O. Linux * Ram 4GB o superior * Disco Duro 64 GB * Publicar la URL y Puerto del WildFly === Proceso === Siga los siguientes pasos para utilizar la funcionalidad * Antes de iniciar debe asegurarse que dispone del CUFE, CUNE O CUDS del documento principal. * El puerto por defecto de la solución es 8088. Se puede modificar en el application.properties y volver a [[ada:howto:sicoferp:factory:integrations:deployspringboot|Generar el war]] . * [[ada:howto:sicoferp:factory:integrations:deployspringboot|Desplegar como war]] * Validar Ejemplo de Consumo - Index: http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/ * Validar Documentación Swagger: http://10.1.20.84:3131/SicofDownloadDocumentDB/v3/api-docs ===== Ejemplos de Consumos ===== La utiidad se puede utilizar desde cualquier navegador web que este conectado a internet y esté dentro de la red de ADA. Tambien puede utilizar una herrameinta para consumo de Apis Rest como Postman, etc. ==== Recomendaciones ==== * Identifica el código únnico de identificación del documento que se desea descargar los cuales pueden ser (CUFE:FE - CUNE:ND, NC - CUDS: DS) * Identifique el tipo de archivo que se desea descargar los cuales pueden ser (fv:XML del documento FE, NC, ND o DS - ad: document attachment del documento FE, NC, ND o DS - pdf: Representación gráfica del documento FE, NC, ND o DS) * Arme la url del servicio previamente en un editor de texto teniendo presente la siguiente estructura: URL: es la ruta del servicio http://10.1.20.84:3131/SicofDownload/exportDocumentDian, operación la cual puede ser file o read, Código único de identificación del documento el cual es un hash y por último el tipo de archivo que se desea exportar el cual puede ser (fv:xml documento - ad:xml document attachment - pdf: representación gráfica). ==== Testerar disponibilidad del servicio ==== ^Http^Url^Request^Response^ |GET|http://10.1.20.84:3131/SicofDownload/exportDocumentDian/|N/A|Text| ==== Request ==== Online!!! ==== Descarga un documento ==== ^Http^Url^Response^ |GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/file/(CUFE,CUNE,CUDS)/pdf|PDF| |GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/file/(CUFE,CUNE,CUDS)/fv|XML| |GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/file/(CUFE,CUNE,CUDS)/ad|XML| ==== Ejemplo ==== http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/file/45f477dee2038a13c43f6e748fecb92303e1c67006bd3866fb96f0f3502acb7618d4b31bb8e31b1a09352a7349cb773f/pdf ==== Request ==== File ==== Consultar el registro un documento ==== ^Http^Url^Request^Response^ |GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/read/|45f477dee2038a13c43f6e748fecb92303e1c67006bd3866fb96f0f3502acb7618d4b31bb8e31b1a09352a7349cb773f/pdf/|Info SQL| |GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/read/|45f477dee2038a13c43f6e748fecb92303e1c67006bd3866fb96f0f3502acb7618d4b31bb8e31b1a09352a7349cb773f/fv/|Info SQL| |GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/read/|45f477dee2038a13c43f6e748fecb92303e1c67006bd3866fb96f0f3502acb7618d4b31bb8e31b1a09352a7349cb773f/ad/|Info SQL| ==== Request ==== Consulta SQL ==== Códigos de Respuesta ==== ^Código^Mensaje^ |200|Petición procesada correctamente. Se devuelve el registro o el archivo consultado.| |404|No se identifica el recurso solicitado con los parámetros ingresados. No existe| |500|Error interno en el servidor. Se debe consultar el log del servidor para más información| [[ada:howto:sicoferp:factory:integrations|←Volver atrás]]