Como utilizar el Kit de integración#
Este kit le permitirá familiarizarse con el proceso de integración de nuestra plataforma, incluyendo las guías de integración, los mensajes JSON (DTO), el funcionamiento general del sistema y los manuales relacionados con el proceso de documentación electrónica.
Que contiene el KIT:#
1. Centro de conocimiento:
https://www.saphety.co/soporte/
2. URL’s de acceso en ambiente de QA:
Artefacto |
URL |
|---|---|
|
Servicio Web (Web Api): |
|
Modelo del REST API: |
|
Plataforma SaphetyDoc: |
3. Datos de acceso en ambiente de QA:
Si desea habilitar usuarios para acceder a los servicios y plataformas de SOVOS Saphety, le informamos que las solicitudes deben gestionarse a través de alguno de los siguientes canales:
Equipo comercial:
Johana Alexandra Caicedo Ríos 📧 Johana.Caicedo@sovos.com 📞 +57 317 376 5392
Jenniffer Rozo 📧 Jenniffer.Rozo@sovos.com 📞 +57 318 460 0516
Karoll Cuadros Castañeda 📧 Karoll.Cuadros@sovos.com 📞 +57 316 310 1369
Canal de soporte: 🔗 https://procesosyprocesos.freshdesk.com/support/home
Estaremos encantados de asistirle durante el proceso, garantizando una configuración adecuada y segura de los accesos.
4. Guías de integración estándar.
Las guías de integración estándar se encuentran disponibles en los siguientes apartados:
Facturación Electrónica::
Nomina Electrónica:
Documento Soporte:
Documento Equivalente:
5. Colección POSTMAN de ejemplo para simular el proceso de transmisión de documentos
A continuación, encontrará la URL de la colección que debe ser importada en POSTMAN:
🔗 Colección POSTMAN – Kit de Integración Saphety
También puede consultar la guía de configuración POSTMAN para la colección SaphetyDOC, disponible en nuestro Centro de Conocimiento en la siguiente ruta:
Información técnica → Documentación → Kit de integración
Uso del Kit de Integración#
Solicitar TOKEN de seguridad#
1. Localiza la colección “Kit de Integración” dentro del Workspace.
2. Expande la colección, busca la carpeta llamada “Autenticación” y selecciona la petición “Solicitar Token de Seguridad”.
3. A continuación, se mostrará la petición con toda la información relacionada con la solicitud del TOKEN de seguridad.
4. En esta sección podrás visualizar la URL del servicio que se está consumiendo.
5. También podrás ver el mensaje en formato JSON que se enviará al servicio.
Note
No modifiques los valores directamente en esta sección. Si deseas personalizarlos con tus datos de acceso, edítalos desde el Environment.
6. Haz clic en el botón “Send” para enviar la solicitud “Solicitar Token de Seguridad” al API REST de SAPHETY.
7. Una vez enviada la solicitud, la respuesta se mostrará en la parte inferior de la pantalla. Allí podrás visualizar el TOKEN de seguridad obtenido.
Crear una Factura de venta#
1. Localiza la colección “Kit de Integración” dentro del Workspace.
2. Expande la colección y navega por las carpetas en el siguiente orden: Documentos → Facturación Electrónica → Emisión. Luego, haz clic en la petición denominada “Crear una Factura de Venta”.
3. A continuación, se mostrará la petición con toda la información relacionada con la creación de una Factura de Venta.
4. En esta sección podrás visualizar la URL del servicio que se está consumiendo.
5. Es importante actualizar el consecutivo (SerieNumber) y la fecha de emisión (IssueDate) dentro del mensaje en formato JSON que se enviará al servicio.
Los valores del consecutivo deben estar dentro del rango de 1 a 5,000,000.
6. Haz clic en el botón “Send” para enviar la solicitud de creación de la Factura de Venta al API REST de Saphety.
7. Una vez enviada la solicitud, la respuesta se mostrará en la parte inferior de la pantalla. En ella podrás visualizar el ID del documento creado exitosamente en Saphety.
Crear una Nómina electrónica#
1. Localiza la colección “Kit de Integración” dentro del Workspace.
2. Expande la colección y navega por las carpetas en el siguiente orden: Documentos → Nómina Electrónica → Emisión. Luego, haz clic en la petición denominada “Crear una Nómina Electrónica”.
3. A continuación, se mostrará la petición con toda la información relacionada con la creación de una Nómina Electrónica.
4. En esta sección podrás visualizar la URL del servicio que se está consumiendo.
5. Es importante actualizar el consecutivo dentro del mensaje en formato JSON que se enviará al servicio.
Note
El Prefijo + Consecutivo no debe superar los 15 caracteres.
6. Haz clic en el botón “Send” para enviar la solicitud de creación de la Nómina Electrónica al API REST de Saphety.
7. Una vez enviada la solicitud, la respuesta se mostrará en la parte inferior de la pantalla. En ella podrás visualizar el ID del documento creado exitosamente en Saphety.
Crear un Documento Soporte a no obligados a Facturar#
1. Ubica la opción para visualizar la colección “Kit de integración” dentro del WORKSPACE.
2. Expande la colección y navega hasta la carpeta: Documentos -> Documento Soporte -> Emisión. Luego, haz clic en la petición llamada “Crear un Documento Soporte en Adquisiciones Efectuadas a No Obligados a Facturar”.
3. A continuación, se mostrará la petición con toda la información relacionada con la creación de un Documento Soporte.
4. Podrás visualizar la URL del servicio que estás consumiendo.
5. Es importante actualizar el Consecutivo (SerieNumber) y la fecha de emisión (IssueDate) en el mensaje (formato JSON) que se enviará al servicio.
El rango para el consecutivo debe estar entre 1 y 5,000,000.
6. Haz clic en el botón “Send” para enviar la solicitud de creación del Documento Soporte al API REST de SAPHETY.
7. Después de hacer clic en “Send”, la respuesta aparecerá en esta sección y contendrá el ID del documento creado en SAPHETY.
Visualizar Documentos Emitidos#
Después de emitir un documento, puede ingresar a la plataforma SaphetyDoc y dirigirse a la sección de documentos enviados.
1. Ubique la opción correspondiente para visualizar los documentos emitidos.
Para Facturación Electrónica:
Para Nómina Electrónica:
2. A continuación, se abrirá una nueva ventana donde podrá ver todos los documentos emitidos en SAPHETY. Para consultar un documento específico, haga clic sobre su número.
Para Facturación Electrónica:
Para Nómina Electrónica:
3. A continuación, se mostrará el detalle completo del documento emitido a través de SAPHETY.
Para Facturación Electrónica:
Para Nómina Electrónica:
Creación de documentos electrónicos en recepción#
1. Ubica la opción para visualizar la colección “Kit de integración” dentro del “WORKSPACE”.
2. Expande la colección y ubica dentro de la carpeta con el nombre “Documentos” → “Facturación electrónica” → “Recepción” y luego haz clic en la petición llamada “Creación de documentos electrónicos en recepción”.
3. A continuación, se mostrará la petición con toda la información relacionada a la creación de documentos electrónicos en recepción.
4. Aquí podrás visualizar la URL del servicio que estás consumiendo.
5. También se mostrará el mensaje en formato JSON que será enviado al servicio.
6. Haz clic en el botón “Send” para realizar la creación de documentos electrónicos en recepción mediante la API REST de SAPHETY.
7. Luego de hacer clic en “Send”, la respuesta aparecerá en esta sección, incluyendo el ID del documento creado en SAPHETY.
Consultar documentos electrónicos recibidos#
1. Ubica y selecciona la colección “Kit de integración” dentro del WORKSPACE.
2. Expande la colección y navega hasta la carpeta “Documentos” → “Facturación electrónica” → “Recepción”. Luego, haz clic en la petición denominada “Consultar documentos electrónicos recibidos”.
3. A continuación, se mostrará la petición con toda la información relacionada con la consulta de documentos electrónicos recibidos.
4. Aquí podrás ver la URL del servicio que se está consumiendo.
5. También se mostrará el mensaje en formato JSON que se enviará al servicio.
6. Haz clic en el botón “Send” para realizar la consulta de documentos electrónicos recibidos al API REST de SAPHETY.
7. Después de hacer clic en “Send”, la respuesta aparecerá en esta sección, mostrando todos los ID de los documentos recibidos en SAPHETY.
Consultar formatos de documentos electrónicos recibidos#
1. Ubica la opción para visualizar la colección “Kit de integración” dentro del WORKSPACE.
2. Expande la colección y navega a la carpeta “Documentos” → “Facturación electrónica” → “Recepción”. Luego, haz clic en la petición llamada “Obtener UBL en Binario de documentos electrónicos recibidos” o en “Obtener PDF en Binario de documentos electrónicos recibidos”.
3. A continuación, se mostrará la petición con toda la información relacionada a la obtención de documentos electrónicos recibidos.
4. Podrás visualizar la URL del servicio que estás consumiendo.
5. También se mostrarán los parámetros que se enviarán al servicio.
6. Haz clic en el botón “Send” para ejecutar la petición “Obtener UBL en Binario de documentos electrónicos recibidos” o “Obtener PDF en Binario de documentos electrónicos recibidos” al API REST de SAPHETY.
7. Después de hacer clic en “Send”, la respuesta aparecerá en esta sección, y contendrá el formato del documento recibido codificado en Base64.
Important
Recomendaciones:
Agradecemos no realizar cambios en la contraseña ni en el perfil del usuario suministrado.
Tenga en cuenta que al enviar un documento a través de nuestra plataforma en el ambiente de QA, se enviará una notificación al correo electrónico especificado en el mensaje DTO. Por esta razón, recomendamos no utilizar las cuentas de correo de los clientes finales para estas pruebas.