Integrationen und APIs
Die öffentlichen API- und MCP-Dienste sind optional. Machen Sie sie verfügbar, wenn Sie möchten, dass externe Integrationen oder KI-Clients Ihre Bereitstellung erreichen.
Beide sind separate Dienste in der Compose-Datei, sodass Sie einen der beiden später hinzufügen können, ohne die App zu berühren. Siehe Dienste und Routing für Domänen und Ports.
Öffentliche API
Der öffentliche API-Dienst wird für Integrationen, Webhooks und API-Dokumente verwendet.
Nach der Veröffentlichung ist die API-Referenz verfügbar unter:
| Pfad | Benutzen |
|---|---|
/docs | Interaktive Skalarreferenz. |
/swagger | Referenz zur Swagger-Benutzeroberfläche. |
/openapi.json | OpenAPI-Dokument für die SDK-Generierung. |
/webhook-event-types | Aktuelle Liste der Webhook-Ereignistypen, die diese Bereitstellung senden kann. |
Zum Beispiel:
https://api.kanera.example.com/docs
https://api.kanera.example.com/webhook-event-types
Siehe API für API-Schlüssel, erste Anfragen, Webhooks und Signaturüberprüfung.
MCP
Mit dem MCP-Dienst können KI-Clients über Streamable HTTP eine Verbindung zu Kanera herstellen.
Bei der Offenlegung ist der Endpunkt:
https://mcp.kanera.example.com/mcp
Die /health Der Weg ist daneben freigelegt. Kanera zeigt Benutzern die genaue MCP-Adresse an, unter der sie ihren KI-Client angeben können Profileinstellungen -> API-Schlüssel, also verweisen Sie die Leute dorthin, anstatt sie zu bitten, die URL zusammenzustellen.
Legen Sie die öffentliche MCP-URL fest, wenn Sie sie verfügbar machen:
MCP_SERVER_PUBLIC_URL=https://mcp.kanera.example.com/mcp
Behalten Sie in Docker Compose die interne MCP-to-public-API-URL bei:
KANERA_PUBLIC_API_URL=http://public-api:3001
MCP-Clients authentifizieren sich mit Kanera-API-Schlüsseln mithilfe von:
Authorization: Bearer kanera_live_...
Verwenden Sie einen persönlichen Schlüssel von Profileinstellungen -> API-Schlüssel für den eigenen KI-Client eines Benutzers auf seinen zugänglichen Boards. Verwenden Sie einen Arbeitsbereichsschlüssel von Arbeitsbereichseinstellungen -> API für gemeinsam genutzte MCP-Clients oder serverseitige Automatisierungen, die an einen Arbeitsbereich angeheftet sind.
OAuth für KI-Agenten
Um kompatiblen Agents die Verbindung über eine Browser-Anmeldung statt über einen API-Schlüssel zu ermöglichen, teilen Sie Kanera seine öffentlichen OAuth-URLs mit. Legen Sie den öffentlichen API-Aussteller fest public-api Service:
PUBLIC_API_OAUTH_ISSUER=https://api.kanera.example.com
Generieren Sie ein separates Geheimnis für den privaten MCP-to-public-API-Token-Austausch:
MCP_INTERNAL_SECRET=<output of openssl rand -hex 32>
Der Wert muss mindestens 32 Zeichen lang sein, darf sich von unterscheiden JWT_SECRET, und müssen in der identisch sein public-api und mcp Dienstleistungen. Die gebündelte Compose-Datei übergibt sie an beide Dienste.
MCP_SERVER_PUBLIC_URL (oben festgelegt) steuert die MCP-Metadaten der geschützten Ressource. Mit dem gebündelten docker-compose.ymlwerden zwei weitere Variablen automatisch abgeleitet: MCP_PUBLIC_URL (die kanonische OAuth-Ressource und MCP-Adresse, die Benutzern angezeigt wird) von MCP_SERVER_PUBLIC_URLund die MCP-Dienste OAUTH_ISSUER_URL von PUBLIC_API_OAUTH_ISSUER.
OAuth-Autorisierungs- und Token-Anfragen binden jeden Code, jede Gewährung, jede Aktualisierungsfamilie und jedes Zugriffstoken an diesen Kanon MCP_PUBLIC_URL. Roh kanera_mcp_... Token funktionieren nur am MCP-Endpunkt und werden von abgelehnt /api/v1; Der MCP-Dienst tauscht sie intern gegen einen separaten, kurzlebigen Delegationsnachweis aus.
Leiten Sie die OAuth-Erkennungspfade an den richtigen Dienst an Ihrem Reverse-Proxy weiter:
| Pfad | Service |
|---|---|
/.well-known/oauth-authorization-server, /oauth/* | public-api |
/.well-known/oauth-protected-resource, /.well-known/oauth-protected-resource/mcp, /mcp | mcp |
Beim Upgrade von einer Version, die OAuth-Tokens ohne Ressourcenbindung ausgegeben hat, werden durch die Migration vorhandene OAuth-Gewährungen und -Tokens widerrufen. Registrierte Client-Definitionen bleiben bestehen, aber Benutzer und unbeaufsichtigte Agenten müssen sich nach der älteren Migration einmal erneut verbinden. Durch die Aktualisierung der Lese-/Schreibrichtlinie werden keine gültigen OAuth-Sitzungen widerrufen, sodass keine erneute Verbindung erforderlich ist.
Siehe Verbinden Sie einen KI-Agenten für den vollen Fluss, und Verbinden Sie Kanera mit Ihrem KI-Agenten für Client-Setup und MCP-Funktionen.
Trello-Importanhänge kopieren
JSON-Importe von Trello-Boards funktionieren ohne zusätzliche Einrichtung.
Damit Benutzer Trello-Dateianhänge in Kanera importieren können, konfigurieren Sie einen Trello-API-Schlüssel:
TRELLO_API_KEY=your-trello-api-key
Erstellen Sie den Schlüssel auf der Power-Up-Administratorseite von Trello unter https://trello.com/power-ups/admin. Es sind keine Power-Up-Funktionen erforderlich. Der Power-Up/App-Eintrag ist nur der Trello-Container für den API-Schlüssel. Benutzer verbinden Trello während des Imports, damit Kanera Anhänge für diesen Import kopieren kann.
Siehe Import aus Trello.