Como utilizar el Kit de integración

Como utilizar el Kit de integración#

Este KIT le permitirá familiarizarse con el proceso de integración de nuestra plataforma, guías de integración, mensajes JSON(DTO), funcionamiento de nuestra plataforma y manuales del proceso de documentación electrónica.

Que contiene el KIT:#

1. Centro de conocimiento:

centroConocimiento

https://www.saphety.co/soporte/

2. URL’s de acceso en ambiente de QA:

Artefacto

URL

API

Servicio Web (Web Api):
https://api-factura-electronica-co-qa.saphety.com/v2/

SWAGGER

Modelo del REST API:
https://api-factura-electronica-co-qa.saphety.com/swagger/index.html

logoSaphety

Plataforma SaphetyDoc:
https://factura-electronica-co-qa.saphety.com/saphety/login

3. Datos de acceso en ambiente de QA:

Si desea habilitar usuarios de acceso a los servicios y plataformas de SOVOS-Saphety, le informamos que las solicitudes deben ser gestionadas a través de alguno de los siguientes canales:

Estaremos encantados de asistirle en el proceso para asegurar una configuración adecuada y segura de los accesos.

4. Guías de integración estándar.

tiposArchivo

Las guías de integración estándar las encontrarán 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 trasmisión de documentos.

  • URL de la colección que debe ser importada:

https://api.postman.com/collections/25121544-bb1f3078-e3d7-4c54-a7d5-564873466cee?access_key=PMAT-01GNWRA3DSXRGHKSKQS660V64C

  • Guía de configuración POSTMAN para colección SaphetyDOC, que se encuentra en nuestro centro de conocimiento (Link -> Información técnica (documentación) -> Kit de integración).

Uso del Kit de Integración#

Solicitar TOKEN de seguridad#

1. Ubica la siguiente opción para visualizar la colección “Kit de integración” del “WORKSPACE”.

2. Expande la colección y ubica dentro de la carpeta con el nombre “Autenticación” y luego haz clic en la petición llamada “Solicitar token de Seguridad”.

token1

3. Enseguida visualizara la petición con toda la información referente a la solicitud de TOKEN de seguridad.

4. Aquí visualizara la URL del servicio que estas consumiendo.

5. Aquí visualizara el Mensaje (en formato JSON) que se enviaría al servicio. Nota: NO CAMBIAR ESTOS VALORES aquí, si desea cambiarlos por sus datos de acceso puede editarlos en la sección de Environment.

6. Hacer clic en el botón “Send” para hacer la “Solicitar token de Seguridad” al API rest de SAPHETY.

7. Enseguida visualizara de hacer clic en el botón “Send”, la respuesta aparecerá en esta sección y en ella contendrá el “token de Seguridad”.

token2

Crear una Factura de venta#

1. Ubica la siguiente opción para visualizar las colección “Kit de integración” del “WORKSPACE”.

2. Expande la colección y ubica dentro de la carpeta con el nombre “Documentos” -> “Facturación electrónica” -> “Emisión” y luego haz clic en la petición llamada “Crear una Factura de venta”.

crearFV_POSTMAN1

3. Enseguida visualizara la petición con toda la información referente a la creación de una Factura de venta.

4. Aquí visualizara la URL del servicio que estas consumiendo.

5. Importante realizar el cambio del Consecutivo (SerieNumber) y la fecha de emision (IssueDate) en el Mensaje (en formato JSON) que se enviaría al servicio (rangos desde 1 hasta 5000000).

6. Hacer clic en el botón “Send” para hacer la “Creación de una Factura de venta” al API rest de SAPHETY.

7. Enseguida visualizara de hacer clic en el botón “Send”, la respuesta aparecerá en esta sección y en ella contendrá el “ID” del documento creado en SAPHETY.

crearFV_POSTMAN2

Crear una Nómina electrónica#

1. Ubica la siguiente opción para visualizar la colección “Kit de integración” del “WORKSPACE”.

2. Expande la colección y ubica dentro de la carpeta con el nombre “Documentos” -> “Nómina electrónica” -> “Emisión” y luego haz clic en la petición llamada “Crear una Nómina electrónica”.

crearNE_POSTMAN1

3. Enseguida visualizara la petición con toda la información referente a la solicitud de Crear una Nómina electrónica .

4. Aquí visualizara la URL del servicio que estas consumiendo.

5. Importante realizar el cambio del Consecutivo y en el Mensaje (en formato JSON) que se enviaría al servicio. Nota: El Prefijo + Consecutivo no debe superar más de 15 caracteres.

6. Hacer clic en el botón “Send” para hacer la “Crear una Nómina electrónica” al API rest de SAPHETY.

7. Enseguida visualizara de hacer clic en el botón “Send”, la respuesta aparecerá en esta sección y en ella contendrá el “ID” del documento creado en SAPHETY.

crearNE_POSTMAN2

Crear un Documento Soporte a no obligados a Facturar#

1. Ubica la siguiente opción para visualizar las colección “Kit de integración” del “WORKSPACE”.

2. Expande la colección y ubica dentro de la carpeta con el nombre “Documentos” -> “Documento Soporte” -> “Emisión” y luego haz clic en la petición llamada “Crear un Documento Soporte en Adquisiciones Efectuadas a no Obligados a Facturar”.

crearDS_POSTMAN1

3. Enseguida visualizara la petición con toda la información referente a la creación de una Documento soporte.

4. Aquí visualizara la URL del servicio que estas consumiendo.

5. Importante realizar el cambio del Consecutivo (SerieNumber) y la fecha de emisión (IssueDate) en el Mensaje (en formato JSON) que se enviaría al servicio (rangos desde 1 hasta 5000000).

6. Hacer clic en el botón “Send” para hacer la “creación de un Documento Soporte” al API rest de SAPHETY.

7. Enseguida visualizara de hacer clic en el botón “Send”, la respuesta aparecerá en esta sección y en ella contendrá el “ID” del documento creado en SAPHETY.

crearDS_POSTMAN2

Visualizar Documentos Emitidos#

Luego de emitir el documento, puede ingresar a la plataforma de SaphetyDoc y dirigirse a documentos enviados.

1. Ubica la siguiente opción para visualizar los documentos emitidos.

Para Facturación Electrónica:

menuSaphetyDocFE

Para Nómina Electrónica:

menuSaphetyDocNE

2. Enseguida visualizara una nueva ventana donde encontrara todos los documentos emitidos en SAPHETY y se debe hacer clic sobre el número del documento.

Para Facturación Electrónica:

menuSaphetyDocFE2

Para Nómina Electrónica:

menuSaphetyDocNE2

3. A continuación se visualiza el detalle del documento emitido a través de SAPHETY.

Para Facturación Electrónica:

menuSaphetyDocFE3

Para Nómina Electrónica:

menuSaphetyDocNE3

Creación de documentos electrónicos en recepción#

1. Ubica la siguiente opción para visualizar la colección “Kit de integración” 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”.

crearRE_POSTMAN1

3. Enseguida visualizara la petición con toda la información referente a la Creación de documentos electrónicos en recepción.

4. Aquí visualizara la URL del servicio que estas consumiendo.

5. Aquí visualizara el Mensaje (en formato JSON) que se enviaría al servicio.

6. Hacer clic en el botón “Send” para hacer la “Creación de documentos electrónicos en recepción” al API rest de SAPHETY.

7. Enseguida visualizara de hacer clic en el botón “Send”, la respuesta aparecerá en esta sección y en ella contendrá el “ID” del documento creado en SAPHETY.

crearRE_POSTMAN2

Consultar documentos electrónicos recibidos#

1. Ubica la siguiente opción para visualizar la colección “Kit de integración” 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 “Consultar documentos electrónicos recibidos”.

consultarRE_POSTMAN1

3. Enseguida visualizara la petición con toda la información referente a la Creación de documentos electrónicos en recepción.

4. Aquí visualizara la URL del servicio que estas consumiendo.

5. Aquí visualizara el Mensaje (en formato JSON) que se enviaría al servicio.

6. Hacer clic en el botón “Send” para hacer la “Consultar documentos electrónicos recibidos” al API rest de SAPHETY.

7. Enseguida visualizara de hacer clic en el botón “Send”, la respuesta aparecerá en esta sección y en ella contendrá todos los “ID” de los documentos recibidos en SAPHETY.

consultarRE_POSTMAN2

Consultar formatos de documentos electrónicos recibidos#

1. Ubica la siguiente opción para visualizar la colección “Kit de integración” 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 “Obtener UBL en Binario de documentos electrónicos recibidos” , “Obtener PDF en Binario de documentos electrónicos recibidos”.

consultarRE_POSTMAN3

3. Enseguida visualizara la petición con toda la información referente a la Creación de documentos electrónicos en recepción.

4. Aquí visualizara la URL del servicio que estas consumiendo.

5. Aquí visualizara los parámetros que se enviaría al servicio.

6. Hacer clic en el botón “Send” para hacer la “Obtener UBL en Binario de documentos electrónicos recibidos” , “Obtener PDF en Binario de documentos electrónicos recibidos”. al API rest de SAPHETY.

7. Enseguida visualizara de hacer clic en el botón “Send”, la respuesta aparecerá en esta sección y en ella contendrá el formato codificado en “Base64” del documento recibido en SAPHETY.

consultarRE_POSTMAN4

Important

Recomendaciones:

  • Agradecemos no hacer cambios al password, ni al perfil del usuario suministrado.

  • Tener presente que al realizar un envío de un documento nuestra plataforma en ambiente de QA, realiza el envío de notificación al correo suministrado en el mensaje DTO, por lo cual recomendamos no utilizar las cuentas de correo de los clientes finales.