API-Referenz

Version 2026-07-01. 10 Operationen in 5 Bereichen – erzeugt aus der veröffentlichten Beschreibung, damit Dokumentation und Produkt zusammenpassen.

Suchen

API-Beschreibung herunterladen

Aktuelle Version 2026-07-01 vom 2026-07-01. Die Dateien entstehen direkt aus der veröffentlichten Schnittstelle – ohne Nacharbeit.

OpenAPI als JSON

Für Generatoren, Testwerkzeuge und eigene Anbindungen.

ryh-api-2026-07-01.openapi.json

HerunterladenIm Browser ansehen

OpenAPI als YAML

Gut lesbar für Prüfungen und die Ablage in der Versionsverwaltung.

ryh-api-2026-07-01.openapi.yaml

HerunterladenIm Browser ansehen

Versionierung

2 veröffentlichte Stände. Keine Änderung mit Anpassungsbedarf in der aktuellen Version.

2026-07-012026-07-01Aktuell
  • Änderung: Referenz wird generiert – Die Endpunktliste entsteht direkt aus der veröffentlichten API-Beschreibung.
  • Neue Funktion: Zustellprotokoll für Webhooks – Zustellungen lassen sich einsehen und gezielt erneut auslösen.
2026-06-122026-06-12
  • Sicherheitsupdate: Vorgangsschlüssel bei verändernden Aufrufen – Verändernde Aufrufe verlangen einen Vorgangsschlüssel und verhindern so Doppelbuchungen.

Übersicht

Selbstauskunft der Schnittstelle

GET/api/public/v1Ohne Anmeldung erreichbar

Übersicht und Fähigkeiten dieser Schnittstelle

Beispielaufruf
curl -X GET https://api.ryh.de/api/public/v1 \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"
GET/api/public/v1/openapi.jsonOhne Anmeldung erreichbar

Diese Beschreibung als OpenAPI-Dokument

Beispielaufruf
curl -X GET https://api.ryh.de/api/public/v1/openapi.json \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"

Netz

Anbieter, Connectoren und Fähigkeiten

GET/api/public/v1/providersAnmeldung erforderlich

Anbieter im Ryh-Netz auflisten

category (query)
Auf eine Kategorie eingrenzen.
Beispielaufruf
curl -X GET https://api.ryh.de/api/public/v1/providers \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"
GET/api/public/v1/connectorsAnmeldung erforderlich

Connectoren auflisten, optional gefiltert

capability (query)
—
providerId (query)
—
category (query)
—
Beispielaufruf
curl -X GET https://api.ryh.de/api/public/v1/connectors \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"
GET/api/public/v1/capabilitiesAnmeldung erforderlich

Katalog aller Fähigkeiten

Beispielaufruf
curl -X GET https://api.ryh.de/api/public/v1/capabilities \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"
POST/api/public/v1/capabilitiesAnmeldung erforderlich

Fähigkeit eines Connectors prüfen

Beispielaufruf
curl -X POST https://api.ryh.de/api/public/v1/capabilities \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"

Verbindungen

Verbindungen eines Betriebs

GET/api/public/v1/connectionsAnmeldung erforderlich

Verbindungen des eigenen Betriebs

Beispielaufruf
curl -X GET https://api.ryh.de/api/public/v1/connections \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"
POST/api/public/v1/connectionsAnmeldung erforderlich

Verbindung anlegen (idempotent)

Idempotency-Key (header) · Pflicht
Vorgangsschlüssel. Gleicher Schlüssel und gleicher Inhalt liefern dieselbe Antwort erneut.
Beispielaufruf
curl -X POST https://api.ryh.de/api/public/v1/connections \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"

Vorgänge

Vorgangsschlüssel und Wiederholsicherheit

POST/api/public/v1/idempotency-keysAnmeldung erforderlich

Neuen Vorgangsschlüssel erzeugen

Beispielaufruf
curl -X POST https://api.ryh.de/api/public/v1/idempotency-keys \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"

Live

Laufende Statusmeldungen

GET/api/public/v1/streamOhne Anmeldung erreichbar

Laufende Statusmeldungen (Server-Sent Events)

Liefert Zustandsänderungen fortlaufend. Nach einem Abbruch wird mit 'Last-Event-ID' oder '?cursor=' lückenlos weitergelesen; jede Meldung trägt eine fortlaufende Nummer und kommt genau einmal an.

cursor (query)
Zuletzt gelesene Nummer.
Last-Event-ID (header)
—
Beispielaufruf
curl -X GET https://api.ryh.de/api/public/v1/stream \
  -H "Authorization: Bearer <zugriffstoken>" \
  -H "X-Ryh-Tenant: <betrieb>"
Diese Seite erfindet keine Endpunkte. Fehlt etwas, ist es noch nicht veröffentlicht – ein Blick in die Roadmap hilft weiter.