Vorlagen auflisten

Was eine Vorlage ist

Eine Vorlage ist ein Dokumentdesign unter einem von Ihnen gewählten Code. Sie hat gleichzeitig zwei Fassungen: einen laufend bearbeiteten Entwurf und eine veröffentlichte Version für die Produktion. Speichern veröffentlicht nicht; unfertige Änderungen erreichen Ihre Kunden daher nicht.

Liefert die Vorlagen Ihres Arbeitsbereichs mit ihren veröffentlichten Versionsnummern. Bei der Erstellung verwenden Sie den Vorlagencode.

curl https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

[
  {
    "templateId": "tpl_eca4c9985ad74913902f0469469936a1",
    "code": "invoice",
    "name": "Unternehmensrechnung",
    "version": 5,
    "publishedVersion": 1,
    "publishedAt": "2026-08-23T08:23:21+00:00"
  }
]

Format der Seitenzahl

Der Inhalt eines Seitenzahlelements ist ein Format: {{ page }} wird zur aktuellen Seite und {{ pages }} zur Gesamtseitenzahl. „{{ page }} / {{ pages }}“ gibt etwa „3 / 12“ aus — mit Seitenzählern im PDF und PAGE/NUMPAGES-Feldcodes in Word. Beide aktualisieren sich beim Hinzufügen von Seiten selbst. Enthält der Inhalt keinen Platzhalter, wird er ignoriert und nur die Seitenzahl ausgegeben.

Version speichern

Beim Speichern wird die Version übermittelt, die Sie Ihrer Annahme nach bearbeiten. Hat jemand zwischenzeitlich gespeichert, nennt die 409-Antwort die aktuelle Version. Nichts wird stillschweigend überschrieben.

curl -X POST https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "code": "invoice",
        "name": "Unternehmensrechnung",
        "saveMode": "manual",
        "expectedVersion": 5,
        "changeReason": "Logo an den rechten Rand verschoben.",
        "definition": {
          "page": { "size": "A4", "orientation": "portrait" },
          "elements": [
            { "type": "text", "text": "Unternehmensrechnung", "fontSize": 24 }
          ]
        }
      }'

HTTP/1.1 409 Conflict

{
  "type": "https://pdfgine.dev/problems/template-conflict",
  "templateCode": "invoice",
  "currentVersion": 6,
  "currentDraftRevision": 0
}

expectedVersion ist optional, aber empfohlen: Ohne diese Angabe gewinnt der letzte Schreibvorgang und die frühere Änderung verschwindet spurlos.

Häufige Fehler

• Wiederholen Sie bei 409 nicht blind dieselbe Anfrage. Lesen Sie currentVersion, übernehmen Sie die neuere Definition, wenden Sie Ihre Änderung darauf an und speichern Sie erneut.
• Speichern ist nicht Veröffentlichen. Die Produktion verwendet die zuletzt veröffentlichte Version, bis Sie den Entwurf veröffentlichen.
• Die Liste liefert höchstens 200 Vorlagen. Bei weiteren Vorlagen enthält die Antwort einen Link-Header mit rel="next". Folgen Sie ihm, statt die erste Seite für die gesamte Bibliothek zu halten.
• Lesen erfordert templates:read, Speichern templates:write. Ein schreibgeschützter Schlüssel liefert beim Speichern 403, nicht 401.
• Über den Code finden alle anderen Aufrufe die Vorlage. Sie können den Namen frei ändern; ein anderer Code bedeutet eine neue Vorlage.