Mehrere Dokumente generieren
Erzeugen → Mehrere Dokumente generieren
Der Mehrere Dokumente generieren API Erzeugt mehrere Dokumente aus einer Vorlage und mehreren Datenelementen. Sie senden die Vorlage (templateFileType, templateFileName, templateFileData Base64), documentDataType (Json oder XML), outputType (Docx, PDFWord, Excel, HTML), documentDataText oder documentDataFileoptional fileMetaData Und metaDataJson, Und async. Der API Rückgaben JSON mit einem outputDocuments Array (oder ein Polling) URL Wann asyncProbieren Sie es mit dem unten stehenden Tester aus; weitere Details finden Sie in den folgenden Abschnitten.
Probieren Sie die Option „Mehrere Dokumente generieren“ aus. API
:::Hinweis Kurzübersicht
Kurzübersicht
Endpunkt: POST /api/v2/GenerateDocumentMultiple · Erforderlich: api-key, templateFileType, templateFileName, templateFileData, documentDataType, outputType, documentDataText
:::
Nutzen Sie das untenstehende Formular, um Ihre Anfrage zu senden API Schlüssel, Vorlagendatei (Base64), Datentyp, Ausgabetyp und Daten (JSON/XML Text oder Datei). Die Antwort lautet: JSON Mit automatisch generierten Dokumenten. Kein Code erforderlich, einfach die Felder ausfüllen und klicken. Anfrage senden.
Überblick, Parameter und Anwendungsfälle
- Overview
- Parameters
- Use cases
Was ist „Mehrere Dokumente generieren“?
Dieser Endpunkt generiert mehrere Dokumente aus einer Vorlage und mehreren Datensätzen (JSON oder XMLSie stellen die Vorlage bereit (Word, HTML, oder PDF als Base64), documentDataType (Json oder XML), outputType (Docx, PDFWord, Excel, HTMLund Daten via documentDataText oder documentDataFile. Der API erzeugt ein Dokument pro Datensatz und gibt diese im Format zurück outputDocuments Array (oder ein Polling) URL Wann async).
Hauptmerkmale
- Eine Vorlage, viele Dokumente: Dieselbe Vorlage wurde mit jedem Datensatz zusammengeführt.
- Vorlagentypen: Docx, Wort, HTML, oder PDF (Base64).
- Daten: documentDataType: Json oder XML; Daten in documentDataText oder documentDataFileDie
- Ausgabe: outputType: Docx, PDF, Word, Excel oder HTMLDie
- Asynchron: Verwenden async für große Mengen.
:::Tipp Ideal für Verwenden Sie diese Vorlage, wenn Sie viele Dokumente aus einer Vorlage benötigen (z. B. Briefe, Zertifikate, Etiketten). Für ein einzelnes Dokument pro Anruf verwenden Sie diese Vorlage. Dokument einzeln generieren.
:::
API Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| api-key | Zeichenkette | Ja | Dein PDF4me API Schlüssel, Base64 kodiert. Holen Sie es sich von der ArmaturenbrettDie |
| templateFileType | Zeichenkette | Ja | Docx, Wort, HTML, oder PDFDie |
| templateFileName | Zeichenkette | Ja | Dateiname der Vorlage mit Dateiendung (z. B. sample.docx). |
| templateFileData | base64 | Ja | Inhalt der Vorlagendatei (Base64). |
| documentDataType | Zeichenkette | Ja | Json oder XMLDie |
| outputType | Zeichenkette | Ja | Docx, PDF, Word, Excel oder HTMLDie |
| documentDataText | Zeichenkette | Ja | JSON/XML Daten als Text (wenn documentDataFile (nicht angegeben). |
| documentDataFile | base64 | NEIN | Datendatei (Base64), Alternative zu documentDataTextDie |
| fileMetaData, metaDataJson | Zeichenkette | NEIN | Zusätzliche Metadaten. |
| async | boolescher Wert | NEIN | Asynchrone Verarbeitung aktivieren. |
Wann sollte man „Mehrere Dokumente generieren“ verwenden?
- Chargenbriefe und Zertifikate: Generieren Sie aus einer Vorlage viele Dokumente mit unterschiedlichen Daten (Briefe, Zertifikate, Etiketten).
- Massenberichte: Mehrere Berichte in einer Anfrage erstellen.
- Massenmailings: Eine Vorlage mit einer Liste von Empfängern oder Datenzeilen zusammenführen.
Für Anfrage-/Antwortschemata und Codebeispiele siehe Mehrere Dokumente generieren im PDF4me API Dokumente.
Voraussetzungen
Bevor Sie diesen Endpunkt verwenden, stellen Sie sicher, dass Sie Folgendes haben:
- Ein gültiger PDF4me API Schlüssel (Hol dir deins API Schlüssel)
- Eine Vorlagendatei (Word, HTML, oder PDF) In Base64 Format
- Daten in JSON oder XML Format
Antwortformat
Der API Rückgaben JSON mit outputDocuments Array mit den generierten Dokumenten zur synchronen Verarbeitung (200 OK) oder bietet eine Umfrage an URL für die asynchrone Verarbeitung (202 Accepted).