Produkt- und API-Leitfaden

Schnellstart

In fünf Minuten zum ersten Dokument

Diese Seite führt Sie von null bis zum gespeicherten PDF. Sie verwendet die Rechnungsvorlage, mit der jeder Arbeitsbereich startet. Sie müssen also nichts vorab gestalten.

1. Ihr Schlüssel

Erstellen Sie unter Konto → API-Schlüssel einen Schlüssel. Der geheime Wert wird einmal angezeigt; halten Sie ihn aus Ihrem Quellcode heraus. Jeder Aufruf übermittelt ihn im Header X-PDFgine-Key.

cURL

# Der Schlüssel gehört in die Umgebung, nicht in den Code
export PDFGINE_KEY="pdfgine_live_..."

# Funktioniert es? Hiermit werden Ihre Vorlagen aufgelistet
curl https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

2. Dokument erstellen

Ein Aufruf mit Vorlagencode und Ihren Daten. Die Antwort lautet 202 und enthält documentId und eine Download-URL.

cURL

curl -X POST https://api.pdfgine.com/api/v1/render \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "templateCode": "invoice",
        "format": "pdf",
        "locale": "de",
        "data": {
          "document": { "title": "Rechnungsübersicht" },
          "referenceNo": "DOC-2026-0042",
          "issueDate": "2026-09-06",
          "currency": "USD",
          "customer": "Northwind Trading Ltd.",
          "lineItems": [
            { "name": "Fehlerdiagnose", "quantity": 2, "unitPrice": 850.00 }
          ]
        }
      }'

Senden Sie beim Ausprobieren einer Vorlage "purpose": "editor-test": Diese Ausgabe verbraucht kein Kontingent und verwendet den unveröffentlichten Entwurf.

3. Herunterladen

Die Download-URL in der Antwort ist relativ zur API-Adresse und wird mit demselben Schlüssel abgerufen. Fordern Sie docx statt pdf an, um dieselben Daten als Word-Datei zu erhalten.

cURL

curl https://api.pdfgine.com/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -o invoice.pdf

Typische erste Stolperstellen

402 bedeutet, dass das monatliche Seitenkontingent verbraucht ist. Der Header X-PDFgine-Quota-Remaining informiert Sie schon vorher.
422 bedeutet, dass Ihre Daten die Vorlage nicht erfüllen. Unter errors nennt der Inhalt jedes fehlende Feld, damit Sie nicht raten müssen.
Die Erstellung antwortet mit 202, nicht 200. Ein Client, der jeden anderen Status als 200 als Fehler behandelt, meldet erfolgreiche Vorgänge fälschlich als Fehler.

Nächste Schritte

Zur Seite „Datenformate“ werden Sie oft zurückkehren: Sie erklärt genau, wie Datum, Betrag und Währung übermittelt werden müssen.

Datenformate →