API DE HERRAMIENTAS PADE

DOCUMENTACIÓN DE LA API DE HERRAMIENTAS PADE

22 marzo, 2021

Revisión Fecha Comentarios
1 2017-12-07 Documento inicial.
2 2020-04-14
Actualización métodos generar pdf, obtener pdf, obtener saldo, obtener xml/pdf

Tabla de contenido

  • Introducción

  • Pre-requisitos.

  • Descripción del Servicio.

  • Métodos

    • Método para generar pdf.

    • Método para obtener pdf.

    • Método para obtener saldo.

    • Método para obtener xml/pdf.

Introducción

La ubicación del WSDL del servicio de herramientas Pade® es la siguiente:  https://timbrado.pade.mx/servicio/herramientas?wsdl

Pre-requisitos

  1. Estar registrado en la plataforma PADE

  2. Datos para la autenticación (Contrato, Usuario y Contraseña)

  3.  
  

Método  GenerarPdf:

Este método nos permite recuperar el pdf en formato base64 de un xml proporcionado

Se encuentra disponible en la siguiente URL:
https://timbrado.pade.mx/servicio/rest/herramientas/generarPdf

Y cuyos parámetros (URL Query Parameters) se describen a continuación:

  • contrato: Clave del contrato de servicios.
  • xml: String con el xml del comprobante del cual se requiere recuperar el pdf.
  • obsBase64: String base64 con las observaciones que seran agregadas al pdf.

Las credenciales (usuario y contraseña) deberán ir en el HEAD de la petición mediante el atributo “Authorization Basic” con el formato usuario:password codificados en base64.

El tipo de contenido (atributo Content-Type) deberá especificar el valor “application/xml“.


No todos los atributos estarán presentes siempre en la respuesta, esto dependerá del flujo del proceso, a continuación se definen:

  • ok: Valores permitidos, true | false, indican el resultado de la
  • operación. En concreto si todo resultó exitosamente y el proceso no presentó errores, el valor esperado será true, por el contrario false.
  • pdfBase64: String en formato base64 del pdf devuelto.
  • mensaje: Mensaje devuelto por el servicio
  • codigo: Indica el estatus de la operación, si el proceso se realizó correctamente el valor esperado es 0, de lo contrario se especifica el código de error.


Códigos devueltos por el servicio

Código
Descripción
0 indica que el proceso o resultado de la operación fue correcto.
2 indica que el contrato especificado no es valido.
1 indica un error en los datos de acceso (usuario, password).
3 indica un error en los parámetros enviados(parámetro inválido)
4 indica un error interno.

Método obtenerPdf:

Este método nos permite recuperar el pdf en formato base64 a partir del uuid del comprobante especificado

Se encuentra disponible en la siguiente URL:
https://timbrado.pade.mx/servicio/rest/herramientas/obtenerPdf

Y cuyos parámetros (URL Query Parameters) se describen a continuación:

  • contrato: Clave del contrato de servicios.
  • uuid: Folio fiscal del comprobante del cual queremos obtener el pdf.
  • obsBase64: String base64 con las observaciones que seran agregadas al pdf.

Las credenciales (usuario y contraseña) deberán ir en el HEAD de la petición mediante el atributo “Authorization Basic” con el formato usuario:password codificados en base64.

El tipo de contenido (atributo Content-Type) deberá especificar el valor “application/xml“.


No todos los atributos estarán presentes siempre en la respuesta, esto dependerá del flujo del proceso, a continuación se definen:

  • ok: Valores permitidos, true | false, indican el resultado de la operación. En concreto si todo resultó exitosamente y el proceso no presentó errores, el valor esperado será true, por el contrario false.
  • pdfBase64: String en formato base64 del pdf devuelto.
  • mensaje: Mensaje devuelto por el servicio
  • codigo: Indica el estatus de la operación, si el proceso se realizó correctamente el valor esperado es 0, de lo contrario se especifica el código de error.


Códigos devueltos por el servicio

Código
Descripción
0 indica que el proceso o resultado de la operación fue correcto.
2 indica que el contrato especificado no es valido.
1 indica un error en los datos de acceso (usuario, password).
3 indica un error en los parámetros enviados(parámetro inválido)
4 indica un error interno.
602 El cfdi especificado no existe

Método  obtenerSaldo:

Este método nos permite recuperar la cantidad de transacciones que tenemos disponible en nuestro contrato de servicios

Se encuentra disponible en la siguiente URL:
https://timbrado.pade.mx/servicio/rest/herramientas/obtenerSaldo

Y cuyos parámetros (URL Query Parameters) se describen a continuación:

  • contrato: Clave del contrato de servicios.
    Las credenciales (usuario y contraseña) deberán ir en el HEAD de la petición mediante el atributo “Authorization Basic” con el formato
  • usuario:password codificados en base64.
    El tipo de contenido (atributo Content-Type) deberá especificar el valor “application/xml“.


Atributos de la respuesta:

  • ok: Valores permitidos, true | false, indican el resultado de la operación. En concreto si todo resultó exitosamente y el proceso no presentó errores, el valor esperado será true, por el contrario false.
  • saldo: Cantidad de transacciones disponibles.
  • mensaje: Mensaje devuelto por el servicio
  • codigo: Indica el estatus de la operación, si el proceso se realizó correctamente el valor esperado es 0, de lo contrario se especifica el código de error.


Códigos devueltos por el servicio

Código
Descripción
0 indica que el proceso o resultado de la operación fue correcto.
2 indica que el contrato especificado no es valido.
1 indica un error en los datos de acceso (usuario, password).
3 indica un error en los parámetros enviados(parámetro inválido)
4 indica un error interno.

Método  obtenerXmlPdf :

Este método nos permite recuperar tanto el xml como el pdf en formato base64 del uuid especificado

Se encuentra disponible en la siguiente URL:
https://timbrado.pade.mx/servicio/rest/herramientas/obtenerXmlPdf

Y cuyos parámetros (URL Query Parameters) se describen a continuación:

  • contrato: Clave del contrato de servicios.
  • uuid: Folio fiscal del comprobante del cual queremos obtener ambos archivos.
  • obsBase64: String base64 con las observaciones que seran agregadas al pdf.

Las credenciales (usuario y contraseña) deberán ir en el HEAD de la petición mediante el atributo “Authorization Basic” con el formato usuario:password codificados en base64.

El tipo de contenido (atributo Content-Type) deberá especificar el valor “application/xml“.


No todos los atributos estarán presentes siempre en la respuesta, esto dependerá del flujo del proceso, a continuación se definen:

  • ok: Valores permitidos, true | false, indican el resultado de la operación. En concreto si todo resultó exitosamente y el proceso no presentó errores, el valor esperado será true, por el contrario false.
  • pdfBase64: String en formato base64 del pdf devuelto.
  • xmlBase64: String en formato base64 del xml devuelto.
  • mensaje: Mensaje devuelto por el servicio
  • codigo: Indica el estatus de la operación, si el proceso se realizó correctamente el valor esperado es 0, de lo contrario se especifica el código de error.


Códigos devueltos por el servicio

Código
Descripción
0 indica que el proceso o resultado de la operación fue correcto.
2 indica que el contrato especificado no es valido.
1 indica un error en los datos de acceso (usuario, password).
3 indica un error en los parámetros enviados (parámetro inválido)
4 indica un error interno.
602 El cfdi especificado no existe