Entwickler

Rechtstexte dort ausliefern, wo sie gebraucht werden.

Veröffentlichte Inhalte stehen über die Public Delivery API in drei Artefaktformen bereit: HTML-Fragmente für direkte Einbettung, JSON für eigene Rendering-Logik und PDF-Artefakte für Anhänge. Signierte, replayfähige Webhooks für Veröffentlichungs­ereignisse sind ab dem Business-Plan verfügbar.

Was ist die Public Delivery API für Rechtstexte?

Public Delivery API für Rechtstexte
Die Public Delivery API ist die read-only Schnittstelle von TermShelf, über die bereits veröffentlichte Rechtstexte als HTML-Fragment, JSON oder PDF-Artefakt abgerufen werden — mit Version Pinning, effective_at und ETag-Caching. Schreibvorgänge und unveröffentlichte Entwürfe sind über sie nicht erreichbar.

Public Delivery API

Read-only. Schnell. Cache-freundlich.

Die Public Delivery API liefert ausschließlich bereits veröffentlichte Inhalte. Schreibvorgänge oder unveröffentlichte Entwürfe sind über diese Schnittstelle nicht erreichbar. Neben der aktuell live ausgelieferten Fassung lässt sich planabhängig auch die zu einem bestimmten Zeitpunkt gültige Version per effective_at abrufen.

HTML-Fragment einbetten

Sanitisierte HTML-Fragmente für direkte Einbindung in Seiten, Apps, Footer oder transaktionale E-Mails.

JSON abrufen

Strukturiertes Format mit Abschnitten, typisierten Blöcken und Metadaten für eigene Templates.

PDF-Artefakt

Freigegebene Versionen als PDF-Artefakt — z. B. zum Mitsenden in Bestell- oder Vertragsmails.

Version pinnen

Eine bestimmte freigegebene Version gezielt anfragen und stabil referenzieren.

ETags & Caching

Caching-fähige Antworten mit ETag und passenden Headern.

Read-only

Keine Schreibvorgänge, keine unveröffentlichten Entwürfe.

OpenAPI 3.1

Vollständige API-Referenz

Alle Endpunkte, Query-Parameter, Antwort-Header (ETag, Cache-Control, Last-Modified, X-Termshelf-Document-Version, X-Termshelf-Published-At, Content-Disposition) und stabilen Fehler-Codes — direkt im Browser navigierbar.

Zur API-Referenz

Beispiel

JSON, HTML und PDF aus derselben Tuple.

Pfadform, Header und Antwort-Hülle entsprechen der Public Delivery API. Drei Artefakte aus genau derselben veröffentlichten Version — wahlweise live oder über effective_at zu einem bestimmten Zeitpunkt.

JSON
GET /v1/delivery/sites/42/documents/privacy
    ?locale=de-DE
    &market=DE
    &profile=B2C

200 OK
Content-Type: application/json
ETag: "v3-a1f2c"
Cache-Control: public, max-age=60, stale-while-revalidate=30
Last-Modified: Tue, 21 Apr 2026 09:30:10 GMT
X-Termshelf-Document-Version: 3
X-Termshelf-Published-At: 2026-04-10T08:00:00Z

{
  "schema_version": 1,
  "api_version": "v1",
  "document": {
    "type_code": "privacy",
    "slug": "privacy-policy",
    "title": "Datenschutzerklärung"
  },
  "target": {
    "site_id": 42,
    "locale_code": "de-DE",
    "market_code": "DE",
    "site_profile_code": "B2C"
  },
  "version": { "number": 3, "published_at": "2026-04-21T09:30:00Z" },
  "sections": [ /* … */ ],
  "meta": {
    "etag": "\"v3-a1f2c\"",
    "built_at": "2026-04-21T09:30:10Z",
    "first_published_at": "2026-04-10T08:00:00Z"
  }
}
HTML-Fragment
GET /v1/delivery/sites/42/documents/privacy/html
    ?locale=de-DE&market=DE&profile=B2C

200 OK
Content-Type: text/html; charset=utf-8
ETag: "v3-a1f2c"
Cache-Control: public, max-age=60, stale-while-revalidate=30
X-Termshelf-Document-Version: 3

<article class="ts-document"
         data-document-type-code="privacy"
         data-document-version="3"
         data-locale="de-DE"
         lang="de-DE">
  <section class="ts-section" data-section-key="main">
    …
  </section>
</article>
PDF-Artefakt
GET /v1/delivery/sites/42/documents/privacy/pdf
    ?locale=de-DE&market=DE&profile=B2C

200 OK
Content-Type: application/pdf
Content-Disposition: attachment;
  filename="termshelf-acme-privacy-de-DE-v3.pdf"
ETag: "v3-a1f2c"
Cache-Control: public, max-age=300, stale-while-revalidate=60
X-Termshelf-Document-Version: 3

<binary PDF content>

# Mit ?version=N kann eine konkrete freigegebene
# Version gepinnt werden. Bei Abweichung antwortet
# die API mit 409 und nennt die aktuell live Version.

Transaktions-Delivery für Rechtstexte

Drei Wege in transaktionale Systeme.

Rechtstexte dort ausliefern, wo Verträge entstehen — in Bestellbestätigungen, Vertrags-Mails, Registrierungs-Flows und Checkout-Schritten.

HTML in E-Mails / Footer

Rechtstext-Abschnitte direkt in transaktionale E-Mails, Footer oder Checkout-Flows einbetten.

JSON für eigene Templates

Strukturierte Inhalte für eigene Mail- oder App-Templates abrufen.

PDF als Anhang

Freigegebene PDF-Artefakte abrufen und z. B. an Bestell-, Vertrags- oder Registrierungsmails anhängen.

TermShelf unterstützt Systeme dabei, freigegebene Rechtstexte in Transaktions-Kommunikation mitzuschicken oder einzubetten. Ob ein konkreter Anwendungsfall rechtlich ausreichend ist, bleibt eine Entscheidung der Nutzenden in Abstimmung mit qualifizierter Beratung.

Webhooks

Veröffentlichungs­ereignisse zustellen.

Signierte, replayfähige Webhooks informieren externe Systeme über neue Publikationen. Verfügbar ab dem Business-Plan; konfiguriert direkt in der Customer-App.

  • HMAC-signierte Zustellung mit rotierbarem Secret
  • Replays über die Operations-Konsole
  • Zustellprotokoll und Retry-Status
  • Optional pro Workspace deaktivierbar

Signaturen

HMAC-Signatur mit eindeutigem Endpoint-Secret pro Workspace.

Replay

Fehlgeschlagene Zustellungen lassen sich gezielt nachverfolgen und neu auslösen.

Claude Code PluginZwei Skills

Integrieren und Marken onboarden — direkt aus Claude Code.

Ein kostenloses Claude-Code-Plugin bringt zwei Skills mit: einen Integration-Skill, der Code für die Public Delivery API generiert (Next.js, Astro, Express, Laravel, reines HTML) — und einen Authoring-Skill, der per Management API neue Marken, Sites, Domains sowie Variablen- und Snippet-Overrides anlegt. Beide laufen im Editor.

  • Integration-Skill: kostenfrei, ohne Account oder API-Key — Code für Next.js, Astro, SvelteKit, Express, Laravel oder reines HTML
  • Authoring-Skill: kompletter Brand-Onboarding-Workflow gegen die Management API — Marke, Site, Domain, Variablen- und Snippet-Overrides
  • Ein Plugin, beide Skills auf einmal installiert; Claude wählt selbst den passenden
  • Authoring stoppt bewusst vor der Veröffentlichung — Freigaben bleiben im Customer-App-Workflow
Im Claude-Code-Terminal installieren
/plugin marketplace add termshelf/claude-plugin
/plugin install termshelf@termshelf

Ein Plugin, ein Befehl — beide Skills sind danach in Claude Code aktiv.

Beispiel — Integration

Bau die TermShelf-Datenschutzerklärung in diese Next.js-App ein.

Beispiel — Authoring

Lege „Acme Legal GmbH“ (https://acme.de) als neue Marke an: Site, Domain und alle Overrides — stop vor dem Publish.

Veröffentlichen, ausliefern, integrieren.

TermShelf bringt Public Delivery API, Transaktions-Delivery und signierte Webhooks in einen klaren Rahmen.

Developer API — Rechtstexte als HTML, JSON und PDF ausliefern