Public Delivery API
Rechtstexte per API ausliefern — HTML, JSON und PDF aus einer Quelle.
Die Public Delivery API stellt veröffentlichte Rechtstexte über eine schnelle, read-only Schnittstelle bereit. Eine freigegebene Version, drei Artefaktformen — konsistent über Websites, Apps, Shops und transaktionale E-Mails.
Was ist die Public Delivery API?
- Public Delivery API
- Die Public Delivery API ist die read-only Auslieferungs-Schnittstelle von TermShelf für bereits veröffentlichte Rechtstexte. Sie gibt eine freigegebene Dokumentversion als sanitisiertes HTML-Fragment, als strukturiertes JSON oder als PDF-Artefakt zurück. Schreibvorgänge und unveröffentlichte Entwürfe sind über diese Schnittstelle nicht erreichbar.
Typische Einsatzfälle
Rechtstexte in die Website einbinden
Datenschutz, Impressum oder AGB als HTML-Fragment serverseitig in CMS-Seiten, Footer oder Landingpages einsetzen — ohne kopierte Volltexte.
In SaaS-Apps rendern
JSON mit Abschnitten und typisierten Blöcken abrufen und mit eigenen Komponenten rendern — in Web-App, native App oder Onboarding-Flow.
PDF an E-Mails anhängen
Die freigegebene Fassung als PDF-Artefakt abrufen und z. B. an Bestell- oder Vertragsbestätigungen anhängen.
Stichtagsbezogen ausliefern
Per effective_at die Version abrufen, die zu einem bestimmten Zeitpunkt live war — planabhängig verfügbar.
Cache-freundlich integrieren
ETag und Cache-Control nutzen, um Antworten zu cachen und mit If-None-Match nur bei Änderungen neu zu laden.
In Shop-Systeme integrieren
Shopware, Shopify oder WooCommerce konsumieren dieselbe Quelle über die API statt verstreuter Pflege im Shop-Backend.
Wie TermShelf hilft
Die API liefert ausschließlich, was zuvor strukturiert versioniert und freigegeben wurde — der Vertrag ist stabil und für AI-Crawler wie für eigene Systeme gleichermaßen lesbar.
Drei Artefaktformen, eine Version
HTML-Fragment, JSON und PDF stammen aus genau derselben veröffentlichten Fassung. Das verhindert Format-Drift zwischen Website, App und E-Mail.
Version Pinning
Mit ?version=N lässt sich eine konkrete freigegebene Fassung gezielt anfragen und stabil referenzieren. Weicht sie von der live-Version ab, antwortet die API mit 409 und nennt die aktuell live Version.
effective_at-Auslieferung
Über ?effective_at=<ISO-8601> lässt sich planabhängig die zu einem Zeitpunkt gültige Fassung abrufen — relevant für Nachweis und Stichtagsbezug.
ETag, Cache-Control und sprechende Header
Antworten tragen ETag, Cache-Control, Last-Modified sowie X-Termshelf-Document-Version und X-Termshelf-Published-At für nachvollziehbare Integrationen.
Read-only und getrennt
Die Public Delivery ist von App- und Admin-Funktionen getrennt; keine Schreibvorgänge, keine unveröffentlichten Entwürfe.
Was die Public Delivery API nicht tut
- Sie erstellt keine Rechtstexte und ersetzt keine anwaltliche Beratung.
- Sie gibt keine unveröffentlichten Entwürfe oder Schreibendpunkte frei.
- Sie ist kein fertiges, zertifiziertes Shop-Plugin — die Einbindung erfolgt integrationsoffen über die API.
- Sie garantiert keine konkrete Endpunkt-Form über die in der API-Referenz dokumentierte hinaus.
Häufige Fragen
- In welchen Formaten liefert die Public Delivery API Rechtstexte aus?
- Als sanitisiertes HTML-Fragment für direkte Einbettung, als strukturiertes JSON für eigene Templates und als PDF-Artefakt für Anhänge — alle drei aus genau derselben veröffentlichten Version.
- Kann ich eine bestimmte Version oder einen Stichtag ausliefern?
- Ja. Mit ?version=N lässt sich eine konkrete freigegebene Fassung pinnen; weicht sie von der live-Version ab, antwortet die API mit 409. Planabhängig liefert ?effective_at=<ISO-8601> die zu einem Zeitpunkt gültige Fassung.
- Sind über die API auch Entwürfe erreichbar?
- Nein. Die Public Delivery API ist read-only und liefert ausschließlich bereits veröffentlichte Inhalte; Schreibvorgänge und unveröffentlichte Entwürfe sind nicht erreichbar.
Shop-, Middleware- und E-Mail-Integrationen
Die Public Delivery API lässt sich auch aus Shop-Systemen, Middleware und E-Mail-Logik konsumieren — als HTML-Fragment, JSON oder PDF-Artefakt aus genau der freigegebenen Version. Wie das je Shop-System aussieht, zeigen diese Guides:
Weiterführend
Veröffentlichen, einmal — ausliefern, überall.
Bring deine Rechtstexte in TermShelf und liefere sie konsistent als HTML, JSON oder PDF aus.