Générer plusieurs documents
Générer → Générer plusieurs documents
Le Générer plusieurs documents API génère plusieurs documents à partir d'un modèle et de plusieurs éléments de données. Vous envoyez le modèle (templateFileType, templateFileName, templateFileData Base64), documentDataType (Json ou XML), outputType (Docx, PDFWord, Excel, HTML), documentDataText ou documentDataFile, facultatif fileMetaData et metaDataJson, et async. Le API retours JSON avec un outputDocuments tableau (ou un système d'interrogation) URL quand asyncUtilisez l'outil de test ci-dessous pour l'essayer ; vous trouverez plus de détails dans les sections suivantes.
Essayez la génération de documents multiples API
Point final : POST /api/v2/GenerateDocumentMultiple · Requis: api-key, templateFileType, templateFileName, templateFileData, documentDataType, outputType, documentDataText
Utilisez le formulaire ci-dessous pour envoyer votre API clé, fichier modèle (Base64), type de données, type de sortie et données (JSON/XML texte ou fichier). La réponse est JSON avec les documents générés. Aucun code requis, remplissez les champs et cliquez Envoyer une requête.
Aperçu, paramètres et cas d'utilisation
- Overview
- Parameters
- Use cases
Qu'est-ce que la génération multiple de documents ?
Ce point de terminaison génère plusieurs documents à partir d'un modèle et de plusieurs enregistrements de données (JSON ou XMLVous fournissez le modèle (Word, HTML, ou PDF comme Base64), documentDataType (Json ou XML), outputType (Docx, PDFWord, Excel, HTML), et des données via documentDataText ou documentDataFile. Le API produit un document par enregistrement de données et les renvoie dans le outputDocuments tableau (ou un système d'interrogation) URL quand async).
Caractéristiques principales
- Un modèle, de nombreux documents: Même modèle fusionné avec chaque enregistrement de données.
- Types de modèles: Docx, Mot, HTML, ou PDF (Base64).
- Données: documentDataType: Json ou XML; données dans documentDataText ou documentDataFile.
- Sortir: outputType: Docx, PDF, Word, Excel ou HTML.
- Asynchrone: Utiliser async pour les grandes quantités.
Conseil : Idéal pour
Utilisez ce modèle lorsque vous avez besoin de nombreux documents à partir d'un seul modèle (lettres groupées, certificats, étiquettes). Pour un seul document par appel, utilisez Générer un document unique.
:::
API paramètres
| Paramètre | Taper | Requis | Description |
|---|---|---|---|
| api-key | chaîne | Oui | Ton PDF4me API clé, Base64 encodé. Récupérez-le depuis le tableau de bord. |
| templateFileType | chaîne | Oui | Docx, Mot, HTML, ou PDF. |
| templateFileName | chaîne | Oui | Nom du fichier modèle avec son extension (par exemple, sample.docx). |
| templateFileData | base64 | Oui | Contenu du fichier modèle (Base64). |
| documentDataType | chaîne | Oui | Json ou XML. |
| outputType | chaîne | Oui | Docx, PDF, Word, Excel ou HTML. |
| documentDataText | chaîne | Oui | JSON/XML données sous forme de texte (si documentDataFile non fourni). |
| documentDataFile | base64 | Non | Fichier de données (Base64), alternative à documentDataText. |
| fileMetaData, metaDataJson | chaîne | Non | Métadonnées supplémentaires. |
| async | booléen | Non | Activer le traitement asynchrone. |
Quand utiliser la génération de documents multiples
- Lettres et certificats par lotsGénérer plusieurs documents à partir d'un seul modèle avec des données différentes (lettres, certificats, étiquettes).
- Rapports en masseGénérer plusieurs rapports en une seule requête.
- envois en masseFusionner un modèle avec une liste de destinataires ou de lignes de données.
Pour les schémas de requête/réponse et des exemples de code, voir Générer plusieurs documents dans le PDF4me API documents.
Prérequis
Avant d'utiliser ce point de terminaison, assurez-vous d'avoir :
- Un valide PDF4me API clé (Obtenez votre API Clé)
- Un fichier modèle (Word, HTML, ou PDF) dans Base64 format
- Données dans JSON ou XML format
Format de réponse
Le API retours JSON avec outputDocuments tableau contenant les documents générés pour le traitement synchrone (200 OK) ou fournit un sondage URL pour le traitement asynchrone (202 Accepted).