Coaching-Live
API-Dokumentation
Anleitung Token & Webhooks Übersicht

Grundsatz

Alles, was die Oberfläche kann, kann die Schnittstelle. Die Oberfläche ist nur ein Client. Basis ist /api, alles JSON, alles UTF-8.

Diese Seite wird aus der laufenden Installation erzeugt — sie beschreibt genau die Version, die hier läuft (Schema-Version ).

Zugang

Lade …


    

Der Schlüssel gehört in die Kopfzeile, nicht in die URL — URLs landen in Protokollen, Verläufen und Proxys.

Ergebnisse abholen

Flache Form: die Spalten

Was liefert welcher Baustein?

Ein Baustein ist eine Methode aus dem Koffer, ausgeführt in einer Session. Mehrere Methoden teilen dasselbe Primitiv und liefern deshalb dieselbe Ergebnisform.

Ereignisse und Webhooks

Jede Zustellung ist ein POST mit dieser Nutzlast:

{
  "ereignis": "pruefung.abgeschlossen",
  "zeit": "2026-07-27T10:15:00.000Z",
  "zustellung_id": "…",
  "session": { "id": "…", "code": "123456", "titel": "…", "kunde": "…", "coach": "…", "status": "live" },
  "daten": { "aktivitaetId": "…", "erfuellungsgrad": 80, "abweichungen": 3 },
  "ergebnisse_url": "/api/sessions/<id>/ergebnisse"
}

Kopfzeilen: X-Coaching-Ereignis, X-Coaching-Zustellung, X-Coaching-Versuch, X-Coaching-Zeit, X-Coaching-Signatur. Die Signatur ist sha256=HMAC(secret, "<zeit>.<rumpf>").

Antwortet das Ziel nicht mit 2xx, wird wiederholt: . Danach gilt die Zustellung als aufgegeben und steht im Zustellprotokoll.

Reine Auffrischungssignale der Oberfläche (jede einzelne Antwort, jeder Phasenwechsel) werden nie zugestellt. Wer den vollen Verlauf braucht, holt ihn über /api/sessions/<id>/ereignisse.

Beratung, Analyse und Berichtsdesign

Die Analyse ist die Nachbereitung: aus den Ergebnissen wird je Beratungsfeld ein Befund mit Belegen abgeleitet, den der Berater prüft und freigibt. Das Übergabepaket hat einen festen Aufbau (apotune.beratung.analyse) mit Versionsnummer im Kopf und führt bei jedem Text mit, ob er abgeleitet oder vom Berater ist.

Verwaltung

Session steuern

Die wichtigsten schreibenden Wege — für Automatisierung, etwa wenn eine Session aus einem Kalendereintrag entstehen soll.

Grenzen, die bleiben