TermShelf
Delivery & Integration

Rechtstexte per API ausliefern: HTML, JSON und PDF

Drei Artefaktformen der Public Delivery API im Vergleich — wann HTML, wann JSON, wann PDF passt.

5 Min. Lesezeit·TermShelf Redaktion

Was die Public Delivery API ausliefert

Die Public Delivery API ist eine read-only Schnittstelle für veröffentlichte Rechtstexte. Sie liefert ausschließlich freigegebene Versionen aus — es gibt keinen Schreibzugriff und keinen Zugriff auf Entwürfe. Damit ist sie eine stabile, öffentlich konsumierbare Quelle für Website, Shop, App und transaktionale E-Mails.

Jeder veröffentlichte Rechtstext steht in drei Artefaktformen bereit: HTML, JSON und PDF. Welche Form passt, hängt vom konsumierenden System ab — nicht vom Rechtstext selbst. Den vollständigen Auslieferungs-Vertrag fasst die Feature-Seite Public Delivery API zusammen.

HTML, JSON und PDF im Vergleich

  • HTML-Fragment: Fertig gerendeter Abschnitt zum direkten Einbetten in eine Seite, einen Footer oder eine E-Mail. Das konsumierende System muss nichts über die interne Struktur wissen.
  • JSON: Strukturierte Repräsentation mit Abschnitten und Metadaten — für Systeme, die eigenes Layout, eigene Komponenten oder eigene Mail-Templates rendern.
  • PDF: Aus genau der freigegebenen Fassung erzeugtes Dokument — geeignet als Anhang in Bestell- und Vertragsbestätigungen.

Caching, ETag und Versionsbezug

Weil veröffentlichte Versionen unveränderlich sind, sind die Antworten gut cachebar. Über ETag und bedingte Anfragen (If-None-Match) lassen sich unveränderte Inhalte mit 304 Not Modified beantworten, statt sie erneut zu übertragen.

Für deterministische Auslieferung lässt sich eine konkrete Fassung per ?version=N pinnen; weicht sie vom aktuellen Live-Stand ab, antwortet die API mit 409 version_mismatch und nennt die aktuelle Version. Alternativ liefert ?effective_at=<ISO-8601> die zu einem Zeitpunkt veröffentlichte Fassung. Endpunkte, Header und Fehlercodes im Detail stehen in der API-Referenz.

Einbettung in Website, Shop, App und E-Mail

Das Muster ist überall gleich: einmal zentral veröffentlichen, überall dieselbe Quelle konsumieren. Eine Website bettet das HTML-Fragment ein, eine App rendert das JSON in eigenen Komponenten, ein Shop hängt das PDF an die Bestellbestätigung. Keine kopierten Volltexte, kein paralleler Pflegeaufwand.

Für Shop-Systeme konkret: siehe Rechtstexte in Shopware, Shopify und WooCommerce. Die Abgrenzung gegen verstreute Pflege behandelt warum Rechtstexte nicht im CMS verstreut liegen sollten.

Abgrenzung

TermShelf erstellt keine rechtsverbindlichen Inhalte und ersetzt keine anwaltliche Beratung. Die API ist ein technischer Auslieferungsweg für bereits freigegebene Inhalte.

Häufige Fragen

Kann ich über die API Rechtstexte ändern?
Nein. Die Public Delivery API ist read-only und liefert ausschließlich freigegebene Versionen aus. Authoring und Freigabe finden in der TermShelf-Anwendung statt.
In welchen Formaten liefert die API?
Als HTML-Fragment, als JSON und als PDF — jeweils aus derselben freigegebenen Version. Die Form wählt das konsumierende System.

TermShelf ausprobieren

Strukturen, Versionen und Veröffentlichungen in einem Workflow.

Kostenlos starten

Verwandte Guides

Rechtstexte per API ausliefern: HTML, JSON und PDF — TermShelf