Produkt- und API-Leitfaden

Entwürfe, Veröffentlichung und Versionen

Speichern ist nicht Veröffentlichen

Speichern aktualisiert den bearbeiteten Vorlagenentwurf. Veröffentlichen legt eine Produktionsversion fest. Eine Vorlage kann eine veröffentlichte Version haben, während Sie an einem neueren Entwurf arbeiten. Nehmen Sie nicht an, dass Entwurfsänderungen bereits veröffentlicht sind.

Vor der Veröffentlichung

Prüfen Sie die Vorschau mit Beispieldaten und realistischen langen Daten sowie die benötigten Ausgabeformate. Vergleichen Sie aktive und veröffentlichte Version im Verlauf. Veröffentlichen Sie, wenn der gewünschte Produktionsinhalt fertig ist.

Aus dem Verlauf wiederherstellen

Das Wiederherstellen einer früheren Version speichert deren Inhalt als neue aktive Version und löscht keinen Verlauf. Prüfen Sie den Inhalt danach erneut. Veröffentlichen Sie separat, wenn auch die veröffentlichte Version ersetzt werden soll.

Version lesen, wiederherstellen und veröffentlichen

Jedes manuelle Speichern legt eine neue Version an; nichts wird überschrieben. Das Wiederherstellen einer älteren Version löscht keine neueren Versionen, sondern speichert die alte Definition als neue Version. So bleibt der Verlauf vollständig.

cURL 
# Versionsliste - neueste zuerst
curl -s https://api.pdfgine.com/api/v1/templates/invoice/history \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

# Definition einer Version
curl -s https://api.pdfgine.com/api/v1/templates/invoice/history/3 \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

# Zu dieser Version zurückkehren - als neue Version gespeichert, die alte bleibt erhalten
curl -X POST https://api.pdfgine.com/api/v1/templates/invoice/history/3/restore \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

# Entwurf veröffentlichen
curl -X POST https://api.pdfgine.com/api/v1/templates/invoice/publish \
  -H "X-PDFgine-Key: $PDFGINE_KEY"
HTTP 409 
{
  "type": "https://pdfgine.dev/problems/template-conflict",
  "title": "Vorlagenkonflikt",
  "status": 409,
  "detail": "Die Vorlage wurde durch einen anderen Vorgang geändert. Laden Sie die aktuelle Version und versuchen Sie es erneut.",
  "templateCode": "invoice",
  "currentVersion": 19,
  "currentDraftRevision": 0
}

Ein Schreibvorgang mit veralteter expectedVersion wird abgelehnt statt zusammengeführt. Die 409-Antwort nennt die Vorlage, ihre aktuelle Version und Entwurfsrevision. Lesen Sie die aktuelle Definition, wenden Sie Ihre Änderung erneut an und schreiben Sie nochmals.

Konflikte und Verbindungscodes

Speichern auf Basis einer alten Version kann zu Konflikten führen, wenn eine andere Sitzung dieselbe Vorlage verändert hat. Prüfen Sie aktuellen Stand und Verlauf, statt Änderungen blind zu überschreiben. Der Verbindungscode identifiziert die Vorlage in API-Anfragen. Ändert er sich, aktualisieren Sie auch entsprechende Integrationen.

Vollständiger Berichtsablauf →

Häufige Fehler

  • Speichern ist nicht Veröffentlichen. Ein Entwurf kann seit Tagen fertig sein, während die Produktion weiter die zuletzt veröffentlichte Version ausgibt.
  • Wiederherstellen löscht nichts. Die alte Definition wird als neue Version gespeichert. Der Verlauf bleibt erhalten und die Versionsnummer steigt weiter.
  • Eine 409-Anfrage mit derselben expectedVersion wird erneut abgelehnt. Lesen Sie die aktuelle Version, wenden Sie Ihre Änderung darauf an und schreiben Sie dann.
  • Eine Erstellung mit purpose editor-test verwendet den Entwurf, production die veröffentlichte Version. Zwei scheinbar identische Erstellungen können auf unterschiedlichen Designs beruhen.
  • Der Verlaufsendpunkt unterstützt Seitennavigation. Ohne limit erhalten Sie die neueste Seite und einen Link-Header. Wer diese Seite als vollständigen Verlauf behandelt, übersieht ältere Revisionen.