Dokument einzeln generieren
Erzeugen → Dokument einzeln generieren
Der Dokument einzeln generieren API Erzeugt aus einer Vorlage und Daten ein Dokument. Sie senden die Vorlage (templateFileType, templateFileName, templateFileData Base64), documentDataType (Text, JSON, XML), outputType (html, PDF, Word, Excel), documentDataText oder documentDataFileoptional fileMetaData Und metaDataJson, Und async. Der API Gibt das generierte Dokument zurück (binär oder per Polling). URLProbieren Sie es mit dem unten stehenden Tester aus; weitere Details finden Sie in den folgenden Abschnitten.
Probieren Sie die Funktion „Dokument einzeln generieren“ aus. API
:::Hinweis Kurzübersicht
Kurzübersicht
Endpunkt: POST /api/v2/GenerateDocumentSingle · 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 ist das generierte Dokument. Kein Code erforderlich, Felder ausfüllen und klicken. Anfrage senden.
Überblick, Parameter und Anwendungsfälle
- Overview
- Parameters
- Use cases
Was ist „Einzelnes Dokument generieren“?
Dieser Endpunkt generiert ein einzelnes Dokument aus einer Vorlage (Word, HTML, oder PDF) und Daten (JSON oder XMLSie stellen die Vorlagendatei bereit (Base64), templateFileType Und templateFileName, documentDataType (Text, JSON, XML), outputType (html, PDF, Word, Excel) und Daten via documentDataText oder documentDataFile. Der API Fügt die Daten in die Vorlage ein und gibt das generierte Dokument zurück. Optional verwenden fileMetaData Und metaDataJson für zusätzliche Metadaten.
Hauptmerkmale
- Vorlagentypen: Wort, HTML, oder PDF Vorlagen (Base64).
- Daten: documentDataType: Text, JSON, oder XML; Daten in documentDataText oder documentDataFile (Base64).
- Ausgabe: outputType: html, PDF, Word oder Excel.
- Asynchron: Verwenden async für große Vorlagen oder Datenmengen.
:::Tipp Ideal für Verwenden Sie diese Vorlage, wenn Sie pro Anruf ein Dokument benötigen (Rechnungen, Briefe, Berichte). Für mehrere Dokumente aus einer Vorlage verwenden Sie diese Vorlage. Mehrere Dokumente 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 | HTML, Word, PDF, HTML, oder DOCXDie |
| templateFileName | Zeichenkette | Ja | Name der Vorlagendatei mit Dateiendung (z. B. invoice_template.html). |
| templateFileData | base64 | Ja | Inhalt der Vorlagendatei (Base64). |
| documentDataType | Zeichenkette | Ja | Text JSON, oder XMLDie |
| outputType | Zeichenkette | Ja | html, 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 „Dokument einzeln generieren“ verwendet werden?
- Rechnungen und Briefe: Pro Vorlage (Rechnung, Vertrag, Brief) wird ein Dokument mit zusammengeführten Daten generiert.
- Berichte: Erstellen Sie einen einzelnen Bericht aus einer Vorlage und JSON/XML Daten.
- Zertifikate: Pro Anruf wird ein Zertifikat oder Dokument generiert.
Für Anfrage-/Antwortschemata und Codebeispiele siehe Dokument einzeln 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 Gibt das generierte Dokument als Binärdaten zur synchronen Verarbeitung zurück (200 OK) oder bietet eine Umfrage an URL für die asynchrone Verarbeitung (202 Accepted).