API

Owner und Admins verwalten den Schlüssel auf der Dashboard-Seite Öffentliche API unter /integrations/api. /integrations leitet dorthin weiter. Der Docs-Button unten rechts öffnet diese Anleitung, nicht den REST-Quickstart allein. Endpunkte, Fehlercodes und Scopes stehen in der REST-API.

Ziel

Ein gespeicherter API-Key mit den gewählten Berechtigungen authentifiziert lesende Aufrufe gegen den Workspace, aus dem der Key stammt.

Voraussetzungen

Benötigte Rolle: Owner oder Admin. Trainer:in sieht Integrationen nicht. Ohne Recht erscheint Keine Berechtigung für Integrationen.
Ein Plan mit Entwickler-API: Studio oder Business. Free und Solo enthalten API, ICS und Webhooks nicht.
Mindestens ein veröffentlichter Kurs, wenn du die Kursliste prüfen willst.

Wo der Schlüssel liegt

Öffne in der Gruppe Integrationen den Eintrag API. Die feste Route ist https://app.orbinaut.ccl-dev.com/integrations/api.
Überschrift Öffentliche API. Untertitel: Lesezugriff auf veröffentlichte Kurse, Buchungen und optional Teilnehmerdaten. Buchen und Bearbeiten gehören nicht zu dieser API.
Der Klartext beginnt mit orb_api_ und erscheint nur beim Erstellen oder Rotieren. Danach zeigt die Tabelle nur Präfix, Version und Status Aktiv oder Widerrufen.
Den Key sehen nur Personen mit Verwaltungsrecht in diesem Workspace. Lege ihn im Zielsystem ab, nicht in Git, Tickets oder Screenshots.

Auf der Seite erklärt der Hinweis Endpunkte und Beispielaufrufe: Die API akzeptiert nur GET. Kurse anlegen, ändern oder buchen ist nicht möglich. Der Button Dokumentation in diesem Hinweis öffnet die REST-Doku mit den Endpunkten. Der Docs-Button unten rechts bleibt bei dieser Dashboard-Anleitung.

Schritte

1. API-Key erstellen

Wähle API-Key erstellen. Hinweis: Wähle die Berechtigungen für das Zielsystem. Der Key wird nur einmal angezeigt.
Trage den Namen ein.
Unter Berechtigungen bleibt courses:read immer an: Immer enthalten. Damit holst du die Kursliste. Optional setzt du bookings:read. participants:read braucht bookings:read und ergänzt Name und E-Mail in Buchungen.
Bestätige mit API-Key erstellen. Erfolg: API-Key wurde erstellt.
Der Dialog API-Key wurde erstellt zeigt den Einmaligen Wert und einen Beispielaufruf mit diesem Key. Kopieren, dann Sicher gespeichert.

In eigenen Aufrufen nur den Platzhalter YOUR_API_KEY verwenden:

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  https://api.orbinaut.ccl-dev.com/api/public/v1/courses

Quickstart und Vertrag: Quickstart, Referenz.

2. Rotieren oder widerrufen

Die Tabelle listet Name, Berechtigungen, Status, Zuletzt verwendet und Aktionen.

Rotieren fragt API-Key rotieren? Der bisherige Key wird sofort ungültig. Der neue Klartext erscheint genau einmal.
Widerrufen fragt API-Key widerrufen? Der Key kann danach nicht mehr verwendet werden. Status Widerrufen.

Ungültige, fehlende oder widerrufene Keys beantwortet die API mit 401 / invalid_api_key. Details: REST-API.

Planlimits

Plan	API, ICS und Webhooks
Free	nein
Solo	nein
Studio	ja
Business	ja

Die API begrenzt auf 120 Anfragen pro Key und 60 Sekunden. Überschreitung: 429 / rate_limit_exceeded. Das Widget hat einen eigenen Key und zählt nicht gegen dieses Limit. Kursliste und Kursdetail liefern höchstens 50 Kurse bzw. Termine je Seite, mit Cursor nextCursor.

Ergebnis

Der Key steht in der Tabelle Öffentliche API mit Präfix und Version.
Der Workspace kommt ausschließlich aus dem Key. Es gibt keinen Parameter für einen anderen Workspace.
Lesende Aufrufe holen veröffentlichte Kurse und optional Buchungen. Die Buchung selbst bleibt auf der öffentlichen Kursseite.

Wenn etwas schiefgeht

Beobachtung	Ursache	Nächster Schritt
Keine Berechtigung für Integrationen	Rolle Trainer:in	Owner oder Admin bitten
Nicht in diesem Plan enthalten.	Free oder Solo	Studio oder Business wählen
Key nach dem Schließen verschwunden	Klartext nur einmal sichtbar	Rotieren und den neuen Wert im Zielsystem ersetzen
`401` / `invalid_api_key`	Key fehlt, rotiert oder widerrufen	Neuen Key erzeugen, `YOUR_API_KEY` im Client aktualisieren
`403` / `missing_scope`	Scope fehlt	Key mit `bookings:read` oder `participants:read` anlegen