API-Schlüssel erstellen

Mit einem persönlichen API-Schlüssel arbeitet ein Skript, eine Integration oder ein KI-Agent in Kanroo in Deinem Namen. Ein Schlüssel darf nie mehr als Dein Konto: Verlierst Du den Zugriff auf ein Board, verliert ihn auch der Schlüssel.

Deine Schlüssel

(vergrößern)

1. Öffne Persönliche Einstellungen über das Kontomenü unten in der Seitenleiste und dann den Tab API-Schlüssel.
2. Mit API-Schlüssel erstellen (Rahmen 1) legst Du einen Schlüssel an.
3. Die Liste (Rahmen 2) zeigt jeden Schlüssel mit Scope, Status, letzter Nutzung und Ablaufdatum.
4. Das Zeilenmenü (Rahmen 3) enthält Umbenennen und Widerrufen. Ein widerrufener Schlüssel funktioniert sofort nicht mehr.

Schlüssel erstellen

(vergrößern)

1. Gib unter Name (Rahmen 1) einen Namen ein, der zeigt, wo Du den Schlüssel einsetzt.

2. Wähle die Berechtigungsstufe (Rahmen 2), also den Umfang der Rechte:

   • Lesen: nur lesen.
   • Schreiben: zusätzlich anlegen, ändern und löschen.
   • Admin: zusätzlich Mitglieder, Einladungen, Teams, Zugriff und alles Öffentliche.

   Scopes der API-Schlüssel listet auf, was jeder Scope erlaubt.

3. Wähle unter Ablauf (Rahmen 3) ein Ablaufdatum. Je kürzer, desto sicherer.

4. Klicke auf Schlüssel erstellen (Rahmen 4). Kanroo zeigt den Schlüssel nur einmal. Kopiere ihn sofort und bewahre ihn in einem Passwortmanager oder einer Umgebungsvariable auf.

Schlüssel verwenden

Sende ihn im Header X-API-Key:

curl -H "X-API-Key: $KANROO_API_KEY" https://cloud.kanroo.app/api/v1/users/me/context

Nur der MCP-Endpunkt /mcp erwartet den Schlüssel als Authorization: Bearer.

Bei einem selbst gehosteten Kanroo nutzt Du Deine eigene Adresse. Dein Kanroo liefert die vollständige API-Referenz unter /api/docs, wenn der Betreiber API_DOCUMENTATION_ENABLED einschaltet.

Gut zu wissen

• Jeder Schlüssel beginnt mit kanroo_. Speichere einen Schlüssel nie in einem Repository.
• API-Schlüssel gehören zu den persönlichen Einstellungen: Hast Du Dich per Single Sign-on (SSO) angemeldet, bittet Kanroo Dich zuerst, Dein persönliches Konto zu bestätigen.
• Ein Schlüssel funktioniert in allen Organisationen, in denen Du Mitglied bist. Ausnahme: Eine Organisation schaltet persönliche API-Schlüssel in ihren SSO-Einstellungen ab.
• In Kanroo Cloud legt der Plan fest, wie viele API-Anfragen eine Organisation pro Minute stellen darf. Siehe Pläne, Preise und Limits.

Verwandte Themen

• KI-Agenten per MCP verbinden
• Board-Ereignisse an Deinen Endpunkt senden