Voraussetzungen
Was du brauchst, bevor du PDFs mit dem Tuix PDF Service erzeugst.
Bevor du ein PDF erzeugst, brauchst du:
- Ein Tuix Konto für den Zugang zum Dashboard.
- Eine Application ID und eine Template ID aus dem Tuix Dashboard.
- Einen API-Key aus dem Tuix Dashboard, siehe API-Keys.
- Die Basis-URL der API (siehe unten).
Basis-URL
Alle Anfragen gehen an:
Die Beispiele in dieser Dokumentation lesen diesen Host aus API_BASE_URL.
IDs finden
Du brauchst zwei IDs aus dem Dashboard: eine Application ID und eine Template ID.
Application ID
Die Application ID identifiziert deine Anwendung und ist Teil des Pfads
(/api/applications/{applicationId}/pdf-files).
Öffne im Dashboard Applications: die Spalte Application ID zeigt den Wert, mit einem Kopier-Symbol daneben.
Template ID
Die Template ID identifiziert die Vorlage, die gerendert wird. Öffne die Vorlagen einer Anwendung: die Spalte Template ID zeigt den Wert, mit einem Kopier-Symbol daneben.
Authentifizierung
Die Authentifizierung läuft über einen API-Key im Header x-api-key:
Ein API-Key hat vollen Zugriff auf die API. Er gehört auf den Server, nie in den Browser und nie in Client-Bundles. Um aus einer Frontend-App zu erzeugen, leite den Aufruf über dein eigenes Backend, siehe Aus einem anderen Service.
Eine Anfrage ohne API-Key antwortet mit 401 Unauthorized, eine Anfrage mit
unbekanntem Key mit 403 Forbidden.