API REST
Ejemplo usando application/json
Request Headers
X-Redoc-Api-Key
RequeridoRedoc API Key necesaria para autenticación. Debe incluirse en todas las solicitudes para permitir el acceso seguro y la conversión de CFDI a PDF.
Content-Type
RequeridoIndica el tipo de medio del recurso enviado. Usar application/json para enviar el CFDI en una cadena de texto como parte del cuerpo del mensaje o multipart/form-data para transferir de forma más eficiente el XML del CFDI.
Accept
OpcionalEspecifica los tipos de medio que el cliente está dispuesto a recibir, como application/pdf para recibir la respuesta como archivo binario o application/json para datos en formato JSON. Esto permite al cliente elegir el formato de respuesta deseado.
Response Headers
Content-Type
Indica el tipo de contenido de la respuesta. Puede ser 'application/json' para datos en formato JSON en donde el PDF esta codificado en base64 o 'application/pdf' para el documento PDF generado.
Content-Length
Longitud del contenido de la respuesta en bytes. Informa el tamaño total del archivo devuelto.
X-Redoc-Transaction-Id
Identificador único para la transacción realizada, facilitando el seguimiento y la auditoría de las solicitudes.
X-Redoc-Pdf-Total-Pages
Número total de páginas del documento PDF generado. Útil para validar la integridad y completitud del documento.
X-Redoc-Xml-Meta
Cadena en base64 que, al decodificarse, se convierte en un objeto JSON con metadatos clave-valor del CFDI procesado. Proporciona información relevante del documento original.
X-Redoc-Process-Total-Time
Tiempo total tomado por el servicio para procesar y generar el PDF, expresado en milisegundos. Permite medir la eficiencia y rendimiento del servicio.
Ejemplo usando application/json
Cuerpo del mensaje
xml
RequeridoContenido del XML del CFDI en formato de cadena de texto. Debe representar fielmente la estructura XML del documento CFDI que se desea convertir a PDF.
encoding
OpcionalEspecifica la codificación de la cadena XML. Es obligatorio solo si el XML no está codificado en base64. Por defecto, se espera que el XML esté en base64. Para usar otro formato de codificación, como UTF-8, indica 'utf8' en este campo.
style_pdf
OpcionalPermite personalizar el estilo del PDF generado. Puedes especificar opciones de estilo como plantillas o formatos predefinidos para que el documento PDF final refleje una presentación acorde a tus preferencias o necesidades empresariales.
Respuesta
{
"content": "PDF encoded as base64..."
}
Copiar