API DE TIMBRADO  ASÍNCRONO

                              Documentación de la API de timbrado Asíncrono - servicio REST

                              Revisión
                              Fecha
                              Comentarios
                              1 2022-­10-11
                              Documento inicial

                              Tabla de Contenido

                              Introducción

                              Esta API permite 



                              Verificar disponibilidad del servicio Se realiza una petición ‘GET’ a la URL:

                              https://pruebas.pade.mx/health


                              Si el servicio está disponible devolverá un objeto Json con estatus “OK” y la descripción mostrada en la siguiente imagen:


                              Ejemplo de la respuesta:

                              {
                               "descripcion": "El servicio está funcionando correctamente",
                               "estatus": "OK"
                              } 


                              Timbrado Asíncrono

                               

                              Para timbrar los comprobantes de manera asíncrona existen los métodos timbradoAsync y timbradoPruebaAsync en los que puedes realizar una petición de timbrado asíncrono en modo real o modo pruebas respectivamente.

                              Se permiten archivos de máximo 250MB.

                              La petición debe de ser de tipo ‘POST’ a las siguientes URLs:

                              https://pruebas.pade.mx/api/timbradoAsync

                              https://pruebas.pade.mx/api/timbradoPruebaAsync


                              En el header se deben incluir la siguiente información: 

                              Key Value
                              Content-Type
                              applicacion/xml 
                              Authorization Basic Son las credenciales (usuario y contraseña) con el formato usuario:password codificados en base64. Estas se utilizarán en la transacción de timbrado. 

                              La siguiente información debe ser incluida como parámetros de URL: 

                              Query Parameter Value
                              contrato
                              Es el contrato que se utilizará en la transacción de timbrado.
                              opciones
                              Son las opciones que se utilizará el servicio en la transacción de timbrado

                              El contenido del XML se debe incluir en el body de la petición como texto plano.

                              os datos no se validan durante esta petición.

                              Si los datos fueron enviados correctamente el servicio devolverá un objeto Json con un token, estatus y descripción:


                              Atributo Valor
                              token
                              Es el identificador de la transacción y se utilizará para recuperar el estatus posteriormente
                              estatus
                              Es el estatus de la transacción. Los únicos estatus utilizados son:
                              - ENCOLADO
                              - EN_PROCESO
                              - TERMINADO
                               descripcion Es la descripción del estatus de la transacción respectivamente:
                              - El archivo fue encolado
                              - El archivo está en proceso
                              - El proceso ha terminado

                              Ejemplo de la respuesta:

                              {
                               "token": "a543000d-6ae3-46d9-bd9a-8e23201bbefe",
                               "estatus": "ENCOLADO",
                               "descripcion": "El archivo fue encolado"
                              } 

                              Obtener estatus de la petición


                              Para obtener el estatus de la petición y dar seguimiento al proceso de timbrado existe el método estatus. Al finalizar el proceso este método devolverá la URL a través de la cual podemos descargar el resultado del Webservice de Timbrado.

                              La petición debe de ser de tipo ‘GET a las siguientes URLs:

                              https://pruebas.pade.mx/api/estatus 


                              Se debe enviar el parámetro token en la URL con el identificador obtenido con anterioridad al depositar el XML. 

                              Query Parameter
                              Value
                              token
                              Identificador obtenido al utilizar los métodos timbradoAsync o timbradoPruebaAsync.

                               


                              La respuesta del servicio es un objeto Json con los probables siguientes atributos:

                              Atributo
                              Valor
                              token
                              Es el token enviado para obtener su estatus
                              estatus
                              Es el estatus de de la petición
                              descripcion
                              Es la descripción del estatus 
                              urlCfdiTimbrado
                              En caso de que el estatus sea TERMINADO, este atributo te dará la URL a través de la cual es posible descargar el resultado del WS de timbrado
                              fechaInicio
                              Fecha en la cual se depositó el XML para su timbrado
                              fechaFin
                              Fecha en la cual terminó el proceso de timbrado


                              Ejemplo de la respuesta cuando el archivo está encolado: 


                                                {
                               "token": "a543000d-6ae3-46d9-bd9a-8e23201bbefe",
                               "estatus": "ENCOLADO",
                              
                                                 "descripcion": "El archivo fue encolado"
                              }
                                              


                              Ejemplo de la respuesta cuando el archivo está en proceso de timbrado: 


                                                 {
                               "token": "a543000d-6ae3-46d9-bd9a-8e23201bbefe",
                               "estatus": "EN_PROCESO",
                               "descripcion": "El archivo está en proceso..."
                              }
                                                
                                                  


                              Ejemplo de la respuesta cuando el proceso de timbrado ha terminado: 

                                                {
                               "token": "a543000d-6ae3-46d9-bd9a-8e23201bbefe",
                               "estatus": "TERMINADO",
                               "descripcion": "El proceso ha terminado.",
                               "urlCfdiTimbrado": "https://pruebascfdiglobal.s3.amazonaws.com/a543000d-6ae3-
                              46d9-bd9a-8e23201bbefe_response?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-AmzDate=20220729T205946Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-AmzCredential=AKIAVY4ZENCZCWFIGKEK%2F20220729%2Fus-east-1%2Fs3%2Faws4_request&X-AmzSignature=ac18f8155bf3dbe4cbbb339c0a8200096bb9a169a0bb586d17bc01a1dce62ed6",
                               "fechaInicio": "202
                                                2-07-29T20:13:12",
                               "fechaFin": "2022-07-29T20:13:42"
                               }