Generar documento único
Generar → Generar documento único
El Generar documento único API genera un documento a partir de una plantilla y datos. Usted envía la plantilla (templateFileType, templateFileName, templateFileData Base64), documentDataType (texto, JSON, XML), outputType (html, PDF, Word, Excel), documentDataText o documentDataFile, opcional fileMetaData y metaDataJson, y async. El API devuelve el documento generado (binario o sondeo) URLUtilice el probador que aparece a continuación para probarlo; encontrará más detalles en las secciones siguientes.
Pruebe la opción Generar documento único API
:::nota Referencia rápida
Punto final: POST /api/v2/GenerateDocumentSingle · Requerido: api-key, templateFileType, templateFileName, templateFileData, documentDataType, outputType, documentDataText
:::
Utiliza el formulario a continuación para enviar tu solicitud API clave, archivo de plantilla (Base64), tipo de datos, tipo de salida y datos (JSON/XML texto o archivo). La respuesta es el documento generado. No se requiere código, complete los campos y haga clic. Enviar solicitud.
Descripción general, parámetros y casos de uso
- Overview
- Parameters
- Use cases
¿Qué es Generar documento único?
Este punto final genera un único documento a partir de una plantilla (Word, HTML, o PDF) y datos (JSON o XML). Usted proporciona el archivo de plantilla (Base64), templateFileType y templateFileName, documentDataType (texto, JSON, XML), outputType (html, PDF, Word, Excel), y datos a través de documentDataText o documentDataFile. El API Combina los datos con la plantilla y devuelve el documento generado. (Opcional) fileMetaData y metaDataJson para metadatos adicionales.
Características principales
- Tipos de plantillas: Palabra, HTML, o PDF plantillas (Base64).
- Datos: documentDataType: texto, JSON, o XML; datos en documentDataText o documentDataFile (Base64).
- Producción: outputType: html, PDF, Word o Excel.
- Asíncrono: Usar async para plantillas o datos grandes.
Usar cuando necesite un documento por llamada (facturas, cartas, informes). Para varios documentos de una misma plantilla, utilice: Generar documentos múltiples.
API parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| api-key | cadena | Sí | Su PDF4me API llave, Base64 codificado. Consíguelo desde el panel. |
| templateFileType | cadena | Sí | html, Word, PDF, HTML, o DOCX. |
| templateFileName | cadena | Sí | Nombre del archivo de plantilla con extensión (por ejemplo, invoice_template.html). |
| templateFileData | base64 | Sí | Contenido del archivo de plantilla (Base64). |
| documentDataType | cadena | Sí | texto, JSON, o XML. |
| outputType | cadena | Sí | html, PDF, Word, Excel o HTML. |
| documentDataText | cadena | Sí | JSON/XML datos como texto (si documentDataFile no se proporciona). |
| documentDataFile | base64 | No | Archivo de datos (Base64), alternativa a documentDataText. |
| fileMetaData, metaDataJson | cadena | No | Metadatos adicionales. |
| async | booleano | No | Habilitar el procesamiento asíncrono. |
Cuándo usar Generar documento único
- Facturas y cartas: Generar un documento por plantilla (factura, contrato, carta) con datos combinados.
- Informes: Generar un único informe a partir de una plantilla y JSON/XML datos.
- Certificados: Generar un certificado o documento por cada llamada.
Para ver esquemas de solicitud/respuesta y ejemplos de código, consulte Generar documento único en el PDF4me API documentos.
Requisitos previos
Antes de utilizar este punto final, asegúrese de tener:
- Un válido PDF4me API llave (Consigue tu API Llave)
- Un archivo de plantilla (Word, HTML, o PDF) en Base64 formato
- Datos en JSON o XML formato
Formato de respuesta
El API devuelve el documento generado como datos binarios para su procesamiento síncrono (200 OK) o proporciona una encuesta URL para procesamiento asíncrono (202 Accepted).