Für Entwickler:innen¶
Rhizome hat eine HTTP-API. Über sie lest und schreibt ihr von außen, was in der Anwendung steht: Themen, Beiträge, Vorschläge, Entscheidungen, Aufgaben, Dokumente, Gruppen.
Sie liegt unter /api/v1. Die vollständige, immer aktuelle Schnittstellenbeschreibung steht als OpenAPI-Dokument unter /api/v1/openapi.json.
Zuerst: die API einschalten¶
Der Zugriff ist pro Organisation abgeschaltet, bis jemand ihn einschaltet – unter Einstellungen → Integrationen → API. Das dürfen die Personen, die auch Integrationen verwalten.
Der Schalter wirkt sofort und rückwirkend
Wird der API-Zugriff wieder abgeschaltet, funktionieren auch bereits ausgestellte Schlüssel nicht mehr.
Einen Schlüssel erstellen¶
Solange die API eingeschaltet ist, erstellt sich jede Person ihre eigenen Schlüssel – ebenfalls unter Einstellungen → Integrationen:
- Name – wofür der Schlüssel da ist, etwa Meine App
- Berechtigung – Nur lesen oder Lesen und schreiben
- Ablaufdatum – optional
Der Schlüssel wird genau einmal angezeigt. Danach lässt er sich nicht wieder einsehen, nur löschen und neu erstellen. Die Tabelle darunter zeigt für jeden Schlüssel, wann er zuletzt verwendet wurde.
Sich anmelden¶
Ein Schlüssel reist im üblichen Header:
Ein Schlüssel handelt als die Person, die ihn erstellt hat. Er sieht genau das, was sie sieht, und darf genau das, was sie darf – ein eigenes Rechtesystem gibt es nicht. Wer eine Integration baut, die mehr sehen soll, benötigt die Berechtigungen einer Person, die mehr sieht.
Nur lesen heißt nur lesen. Ein Lese-Schlüssel wird bei jedem POST, PUT, PATCH und DELETE abgewiesen, unabhängig davon, worauf er zeigt. Die Regel hängt an der HTTP-Methode, nicht an einzelnen Routen.
Was es gibt¶
| Bereich | Was darunter liegt |
|---|---|
| Themen | anlegen, lesen, auflisten; die Unterlisten eines Themas jeweils eigens |
| Beiträge | der Gesprächsverlauf eines Themas |
| Fragen und Vorschläge | Fragen stellen, Vorschläge sammeln und zuordnen |
| Entscheidungen | erstellen, abstimmen, auswerten |
| Beiträge zu Entscheidungen | Einwände, Vetos, Alternativen, Perspektiven |
| Aufgaben | je Thema, und quer über alle, die dir zugewiesen sind |
| Dokumente | die Texte eines Themas |
| Gruppen und Mitglieder | wer wo mitarbeitet |
| Aktivität | was zuletzt passiert ist |
| Tags | Schlagworte an Themen |
Listen lesen¶
Jede Liste nimmt dieselben zwei Parameter: limit (Standard 50, höchstens 200) und offset. Die Antwort sagt mit has_more, ob es weitergeht – blättere mit offset += limit, bis es false ist.
Eine Gesamtzahl gibt es bewusst nicht: Sie zu ermitteln würde jede Seite eine zweite Abfrage kosten.
Die Detailansicht eines Themas ist ebenso begrenzt. Sie beantwortet, worum es geht, und nennt für die Listen, die unbegrenzt wachsen, nur die Anzahl – abrufen lassen sie sich einzeln.
Fehler¶
Die API antwortet mit den üblichen Statuscodes: 400 bei fehlerhaften Angaben, 401 ohne gültigen Schlüssel, 403 wenn die Berechtigung fehlt – auch bei einem Lese-Schlüssel auf einem schreibenden Aufruf –, 404 wenn es die Sache nicht gibt, 409 bei einem Konflikt.
Unbekannte Felder in einem Aufruf werden abgewiesen und nicht stillschweigend übergangen. Ein Tippfehler im Feldnamen fällt damit sofort auf, statt später als fehlende Angabe.
KI-Werkzeuge nutzen
Für KI-Werkzeuge wie Claude oder ChatGPT gibt es den MCP-Layer und eine Sammlung von Skills.
Ereignisse hinausschicken
Wenn du nur Ereignisse aus Rhizome in einen Chat-Kanal wie Slack oder Teams weiterleiten möchtest, benötigst du die API nicht – dafür gibt es Integrationen.