Generar documentos múltiples
Generar → Generar documentos múltiples
El Generar documentos múltiples API genera varios documentos a partir de una plantilla y varios elementos de datos. Usted envía la plantilla (templateFileType, templateFileName, templateFileData Base64), documentDataType (Json o XML), outputType (Docx, PDF, Word, Excel, HTML), documentDataText o documentDataFile, opcional fileMetaData y metaDataJson, y async. El API devoluciones JSON con un outputDocuments matriz (o un sondeo) URL cuando asyncUtilice el probador que aparece a continuación para probarlo; encontrará más detalles en las secciones siguientes.
Pruebe la función Generar documentos múltiples API
:::nota Referencia rápida
Punto final: POST /api/v2/GenerateDocumentMultiple · 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 JSON con documentos generados. 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 Documentos Múltiples?
Este punto final genera múltiples documentos a partir de una plantilla y múltiples registros de datos (JSON o XML). Usted proporciona la plantilla (Word, HTML, o PDF como Base64), documentDataType (Json o XML), outputType (Docx, PDF, Word, Excel, HTML), y datos a través de documentDataText o documentDataFile. El API produce un documento por registro de datos y los devuelve en el outputDocuments matriz (o un sondeo) URL cuando async).
Características principales
- Una plantilla, muchos documentos: Se fusiona la misma plantilla con cada registro de datos.
- Tipos de plantillas: Docx, Palabra, HTML, o PDF (Base64).
- Datos: documentDataType: Json o XML; datos en documentDataText o documentDataFile.
- Producción: outputType: Docx, PDF, Word, Excel o HTML.
- Asíncrono: Usar async para lotes grandes.
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í | Docx, Palabra, HTML, o PDF. |
| templateFileName | cadena | Sí | Nombre del archivo de plantilla con extensión (por ejemplo, sample.docx). |
| templateFileData | base64 | Sí | Contenido del archivo de plantilla (Base64). |
| documentDataType | cadena | Sí | Json o XML. |
| outputType | cadena | Sí | Docx, 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 documentos múltiples
- Cartas y certificados de loteGenerar varios documentos a partir de una plantilla con datos diferentes (cartas, certificados, etiquetas).
- Informes masivosGenerar varios informes en una sola solicitud.
- envíos masivos: Combinar una plantilla con una lista de destinatarios o filas de datos.
Para ver esquemas de solicitud/respuesta y ejemplos de código, consulte Generar documentos múltiples 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 devoluciones JSON con outputDocuments matriz que contiene los documentos generados para el procesamiento síncrono (200 OK) o proporciona una encuesta URL para procesamiento asíncrono (202 Accepted).