Brauche ich das npm-Paket?

Nein. Ist das npm-Paket nicht verfügbar, erzeugst du direkt mit fetch. Siehe Mit fetch erzeugen.

Wie authentifiziere ich mich?

Mit einem API-Key im Header x-api-key. Der Key gehört nur auf den Server. Siehe Voraussetzungen.

Kann ich direkt aus dem Browser erzeugen?

Nicht mit deinem API-Key: jeder Key hat vollen API-Zugriff, im Browser wäre er offengelegt. Rufe den Service aus deinem Backend auf und gib die resultierende URL ans Frontend. Siehe Aus einem anderen Service.

Woher bekomme ich Application ID und Template ID?

Aus dem Tuix Dashboard: die Tabelle Applications zeigt die Application ID, die Vorlagen-Tabelle einer Anwendung die Template ID. Beide Spalten haben ein Kopier-Symbol.

Wie übergebe ich Variablen an die Vorlage?

Über data, ein einfaches JSON-Objekt pro Dokument. In der Vorlage sprichst du die Schlüssel mit ihrem Namen an, z. B. {{ customerName }}. Siehe Template-Syntax.

Kann ich mehrere PDFs in einer Anfrage erzeugen?

Ja, payloads nimmt einen Eintrag pro Dokument, auch mit unterschiedlichen Vorlagen derselben Anwendung. Der Stapel ist alles-oder-nichts.

Was bekomme ich zurück?

Eine URL pro erzeugtem Dokument, dazu die id, die du geschickt hast, zur Zuordnung zu deinen eigenen Entitäten. Siehe Request-Referenz.

Die Anfrage antwortet mit 500, was nun?

Meist ist die Syntax der Vorlage ungültig, z. B. eine Variable mit führendem Punkt ({{ .name }} statt {{ name }}), ein Überbleibsel der früheren Go-Template-Syntax. Prüfe die Vorlage in der Editor-Vorschau. Siehe Template-Syntax.

Warum bekomme ich 403 Forbidden?

Der API-Key ist unbekannt oder wurde gelöscht. 401 heisst dagegen, dass gar kein Key geschickt wurde. Siehe API-Keys.

Grundlagen

Erste Schritte Anwendung anlegen Vorlage anlegen Voraussetzungen API-Keys

PDFs erzeugen

Client installieren Mit fetch erzeugen Aus einem anderen Service PDF herunterladen

Referenz

Request-Referenz Template-Syntax FAQ

FAQ

Häufige Fragen zum Tuix PDF Service.

Zurück

Template-Syntax