Genera documenti multipli
Generare → Genera documenti multipli
IL Genera documenti multipli API genera più documenti da un modello e più elementi di dati. Invii il modello (templateFileType, templateFileName, templateFileData Base64), documentDataType Json O XML), outputType Docx, PDF, Word, Excel, HTML), documentDataText O documentDataFile, facoltativo fileMetaData E metaDataJson, E async. IL API resi JSON con un outputDocuments array (o un polling) URL Quando asyncUtilizza il tester qui sotto per provarlo; maggiori dettagli sono disponibili nelle sezioni seguenti.
Prova a generare documenti multipli API
:::nota - Guida rapida
Punto finale: POST /api/v2/GenerateDocumentMultiple · Necessario: api-key, templateFileType, templateFileName, templateFileData, documentDataType, outputType, documentDataText
:::
Usa il modulo sottostante per inviare il tuo API chiave, file modello (Base64), tipo di dati, tipo di output e dati (JSON/XML testo o file). La risposta è JSON con documenti generati. Nessun codice richiesto, compila i campi e fai clic Invia richiesta.
Panoramica, parametri e casi d'uso
- Overview
- Parameters
- Use cases
Che cos'è la generazione di documenti multipli?
Questo endpoint genera più documenti da un modello e più record di dati (JSON O XML). Fornisci il modello (Word, HTML, O PDF COME Base64), documentDataType Json O XML), outputType Docx, PDF, Word, Excel, HTML), e dati tramite documentDataText O documentDataFile. IL API produce un documento per ogni record di dati e li restituisce nel outputDocuments array (o un polling) URL Quando async).
Caratteristiche principali
- Un unico modello, molti documenti: Lo stesso modello viene unito a ciascun record di dati.
- Tipi di modello: Docx, Parola, HTML, O PDF Base64).
- Dati: documentDataType: Json O XML; dati in documentDataText O documentDataFile.
- Produzione: outputType: Docx, PDF, Word, Excel o HTML.
- Asincrono: Utilizzo async per grandi lotti.
:::suggerimento Ideale per Da usare quando hai bisogno di molti documenti da un unico modello (lettere in blocco, certificati, etichette). Per un singolo documento per chiamata usa Genera documento singolo.
:::
API parametri
| Parametro | Tipo | Necessario | Descrizione |
|---|---|---|---|
| api-key | corda | SÌ | Tuo PDF4me API chiave, Base64 codificato. Prendilo da pannello di controllo. |
| templateFileType | corda | SÌ | Docx, Parola, HTML, O PDF. |
| templateFileName | corda | SÌ | Nome del file modello con estensione (ad esempio sample.docx). |
| templateFileData | base64 | SÌ | Contenuto del file modello (Base64). |
| documentDataType | corda | SÌ | Json O XML. |
| outputType | corda | SÌ | Docx, PDF, Word, Excel o HTML. |
| documentDataText | corda | SÌ | JSON/XML dati come testo (se documentDataFile (non fornito). |
| documentDataFile | base64 | NO | File di dati (Base64), alternativa a documentDataText. |
| fileMetaData, metaDataJson | corda | NO | Metadati aggiuntivi. |
| async | booleano | NO | Abilita l'elaborazione asincrona. |
Quando utilizzare Genera documenti multipli
- Lettere di lotto e certificatiGenera numerosi documenti da un unico modello con dati diversi (lettere, certificati, etichette).
- Rapporti di massaGenera più report con un'unica richiesta.
- Invii di massa: Unisci un modello con un elenco di destinatari o righe di dati.
Per schemi di richiesta/risposta ed esempi di codice, vedere Genera documenti multipli nel PDF4me API documenti.
Prerequisiti
Prima di utilizzare questo endpoint, assicurati di avere:
- Un valido PDF4me API chiave (Ottieni il tuo API Chiave)
- Un file modello (Word, HTML, O PDF) In Base64 formato
- Dati in JSON O XML formato
Formato di risposta
IL API resi JSON con outputDocuments matrice contenente i documenti generati per l'elaborazione sincrona (200 OK) o fornisce un sondaggio URL per l'elaborazione asincrona (202 Accepted).