Mit fetch erzeugen

PDFs ohne npm-Paket erzeugen, direkt gegen die REST-API mit einem API-Key.

Ist das npm-Paket nicht verfügbar, sprich die REST-API direkt an. Der Endpunkt erwartet JSON und einen API-Key im Header x-api-key.

Endpunkt

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

Beispiel

const response = await fetch(
    `${API_BASE_URL}/api/applications/YOUR_APPLICATION_ID/pdf-files`,
    {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
            'x-api-key': process.env.TUIX_PDF_API_KEY,
        },
        body: JSON.stringify({
            payloads: [
                {
                    id: crypto.randomUUID(),
                    templateId: 'YOUR_TEMPLATE_ID',
                    data: { customerName: 'Jane Doe', total: '249.00' },
                },
            ],
        }),
    },
)
 
if (!response.ok) {
    throw new Error(`PDF-Erzeugung fehlgeschlagen: ${response.status}`)
}
 
const { generatedDocuments } = await response.json()

Antwort

{
    "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 der Endpunkt, unter dem das PDF ausgeliefert wird, kein öffentlicher Link. Rufe ihn mit demselben Header x-api-key ab, mit dem du erzeugt hast, plus Accept: application/pdf, siehe PDF herunterladen.

Ein API-Key hat vollen Zugriff auf die API. Rufe diesen Endpunkt nicht mit deinem Key direkt aus dem Browser auf, sondern über dein eigenes Backend, siehe Aus einem anderen Service.

Alle Felder und Statuscodes stehen in der Request-Referenz.

Auf dieser Seite