Documentación

Servicio Web desarrollado con el principal objetivo de validar y timbrar documentos XML con bastante información, empaquetados en un archivo ZIP. La documentación está orientada a la integración de soluciones "consumidoras" de Servicios Web, disponibles actualmente en la plataforma. Constituye la descripción funcional y de interfaz, detallando los parámetros de entrada y salida de cada uno de los métodos.

En la petición del ZIP se agregan los parametros urlwebhook,userwebhook y passwordwebhook para llevar acabo la comunicacón.
Una vez que ha concluido de procesar la petición se envia una respuesta a la urlwebhook para pasarle la URL("PATHRESPONSE") del acuse para su descarga.

El conocimiento de estas funciones y su interfaz (parámetros de entrada y salida), permite la integración en aplicaciones terceras.

RequestZip

El zip no debe pesar más de 1,500,000 bytes (1.5 MB)

El contenido del zip no debe pesar más de 5,500,000 bytes (5.5 MB)

Parámetros de entrada/salida:

Nombre Descripción
usuario Usuario de timbrado.
password Contraseña del servicio de timbrado.
filezip ZIP a enviar para timbrado en webservice en base64.
userwebhook usuario con el cual desea autenticarse al webhook.
passwordwebhook Contraseñacon el cual desea autenticarse al webhook.
urlwebhook Url donde se enviara el PATHRESPONSE que permitira la descarga del acuse del zip procesado.

Recibe Webhook (Parámetros)

Nombre Descripción
idReference Es el identificador del proceso ZIP.
url La url del acuse para su descarga.
msg Mensaje en caso existir algún error.

Request:

 


   
   
      
         
            Prueba*2020P
            prueba12345
         
          
              ?
              ?
              ?
          
         cid:656093825392
      
   

 

Response:

 


   
      
         
            F5BD846E-AC99-4B45-B00B-72FD663B2781
         
      
   

 

ConsultaEstatusZIP

Parámetros de entrada/salida:

Nombre Descripción
usuario Usuario de timbrado.
password Contraseña del servicio de timbrado.
idreference Identificador del archivo en proceso para consultar el estatus en que se encuentra.

Request:

 


   
   
      
         
            Prueba*2020P
            prueba12345
         
         F5BD846E-AC99-4B45-B00B-72FD663B2781
      
   

 

Response:

Posibles respuestas de estatus del archivo

  • estatus 1 - Esperando
  • estatus 2 - Procesando
  • estatus 3 - Completado
 


   
      
         
            3
            0
            https://url_del_archivo.zip
         
      
   

 

Cliente ProcesarZIP (WebService Pruebas)

Puede descargar el cliente desde el siguiente enlace:

ProcesarZip

Instrucciones de uso:

  • Ejecutar el archivo ProcesarZip.bat
  • Seleccionar folder donde se encuentran los XML a procesar
  • Introducir usuario y password para ambiente de pruebas
  • Oprimir el botón Guardar Configuración
  • Oprimir boton Timbrar Archivos el cual generará la archivo ZIP y lo enviará al WebService para procesarlo.
Nota: Los archivos de respuesta o timbrados se generan en una carpeta llamada "documentos/timbrado" que se crea automáticamente en la carpeta de ejecución del programa.