Request-Referenz der PDF-API | Tuix PDF Service

Eine Anfrage ist ein POST mit JSON-Body, sowohl mit dem npm-Client als auch mit fetch. Die applicationId ist Teil der URL.

POST {API_BASE_URL}/api/applications/{applicationId}/pdf-files

Anfrage

Feld	Typ	Pflicht	Beschreibung
`applicationId`	string	Ja	ID der Anwendung (Teil des Pfads).
`payloads`	array	Ja	Ein Eintrag pro zu erzeugendem Dokument.
`payloads[].id`	string	Ja	Deine eigene ID, kommt in der Antwort zurück.
`payloads[].templateId`	string	Ja	ID der Vorlage, die gerendert wird.
`payloads[].data`	object	Ja	Variablen der Vorlage, als einfaches JSON-Objekt.

{
    "payloads": [
        {
            "id": "0f7c2d20-1f6e-4f3f-9c14-8d6d4c5f1a2b",
            "templateId": "8b9f0f4a-6f21-4a1e-9d7a-1c2f3e4d5a6b",
            "data": { "customerName": "Jane Doe", "total": "249.00" }
        }
    ]
}

data ist ein Objekt, kein JSON-String. Seine Schlüssel sind die Variablen der Vorlage; Werte dürfen Strings, Zahlen, Booleans, Arrays oder verschachtelte Objekte sein. Siehe Template-Syntax.

Antwort

201 Created mit einem Eintrag pro erzeugtem Dokument:

Feld	Typ	Beschreibung
`generatedDocuments`	array	Ein Eintrag pro Dokument der Anfrage.
`generatedDocuments[].id`	string	Die `id`, die du geschickt hast.
`generatedDocuments[].fileId`	string	ID, die der Service der Datei gab.
`generatedDocuments[].templateId`	string	Die verwendete Vorlage.
`generatedDocuments[].url`	string	Endpunkt, der das PDF ausliefert.

{
    "generatedDocuments": [
        {
            "id": "0f7c2d20-1f6e-4f3f-9c14-8d6d4c5f1a2b",
            "fileId": "f2c1a0d4-7c2e-4e1a-9a9b-3d5f6c7b8a90",
            "templateId": "8b9f0f4a-6f21-4a1e-9d7a-1c2f3e4d5a6b",
            "url": "https://…/api/applications/3b7f1c9e-2d4a-4b8c-9e1f-0a2b3c4d5e6f/pdf-files/f2c1a0d4-7c2e-4e1a-9a9b-3d5f6c7b8a90"
        }
    ]
}

url ist ein Endpunkt dieses Service, kein öffentlicher Link. Das Abrufen braucht deinen API-Key, siehe PDF herunterladen.

Statuscodes

Status	Bedeutung
`201`	Jedes Dokument der Anfrage wurde erzeugt.
`400`	Ungültige `applicationId` oder ungültiger Body.
`401`	Kein API-Key geschickt.
`403`	Unbekannter oder gelöschter API-Key.
`500`	Rendern fehlgeschlagen, z. B. ungültige Liquid-Syntax.

Ein Stapel ist alles-oder-nichts: scheitert ein Dokument, scheitert die Anfrage und es kommen keine URLs zurück, auch nicht für die Dokumente, die sauber gerendert wurden.

Request-Referenz

Anfrage

Antwort

Statuscodes

Auf dieser Seite