Integraties en API's
De openbare API- en MCP-services zijn optioneel. Stel ze bloot wanneer u wilt dat externe integraties of AI-clients uw implementatie bereiken.
Beide zijn afzonderlijke services in het opstelbestand, dus u kunt beide later toevoegen zonder de app aan te raken. Zie Diensten en routering voor domeinen en poorten.
Openbare API
De openbare API-service wordt gebruikt voor integraties, webhooks en API-documenten.
Bij blootstelling is de API-referentie beschikbaar op:
| Pad | Gebruik |
|---|---|
/docs | Interactieve scalaire referentie. |
/swagger | Swagger UI-referentie. |
/openapi.json | OpenAPI-document voor het genereren van SDK's. |
/webhook-event-types | Huidige lijst met typen webhookgebeurtenissen die deze implementatie kan verzenden. |
Bijvoorbeeld:
https://api.kanera.example.com/docs
https://api.kanera.example.com/webhook-event-types
Zie API voor API-sleutels, eerste verzoeken, webhooks en handtekeningverificatie.
MCP
Met de MCP-service kunnen AI-clients verbinding maken met Kanera via Streamable HTTP.
Bij blootstelling is het eindpunt:
https://mcp.kanera.example.com/mcp
De /health pad wordt ernaast blootgelegd. Kanera toont gebruikers het exacte MCP-adres waar ze hun AI-client onder moeten geven Profielinstellingen -> API-sleutels, dus wijs mensen daarheen in plaats van hen te vragen de URL samen te stellen.
Stel de openbare MCP-URL in wanneer u deze openbaar maakt:
MCP_SERVER_PUBLIC_URL=https://mcp.kanera.example.com/mcp
In Docker Compose bewaart u de interne MCP-naar-openbare-API-URL als:
KANERA_PUBLIC_API_URL=http://public-api:3001
MCP-clients authenticeren met Kanera API-sleutels met behulp van:
Authorization: Bearer kanera_live_...
Gebruik een persoonlijke sleutel van Profielinstellingen -> API-sleutels voor de eigen AI-client van een gebruiker op alle toegankelijke borden. Gebruik een werkruimtesleutel van Werkruimte-instellingen -> API voor gedeelde MCP-clients of server-side automatiseringen vastgemaakt aan één werkruimte.
OAuth voor AI-agents
Om compatibele agenten verbinding te laten maken via een browseraanmelding in plaats van een API-sleutel, vertelt u Kanera de openbare OAuth-URL's. Stel de openbare API-uitgever in op de public-api dienst:
PUBLIC_API_OAUTH_ISSUER=https://api.kanera.example.com
Genereer een afzonderlijk geheim voor de particuliere MCP-naar-openbare-API-tokenuitwisseling:
MCP_INTERNAL_SECRET=<output of openssl rand -hex 32>
De waarde moet minimaal 32 tekens lang zijn en moet afwijken van JWT_SECRET, en moet identiek zijn in de public-api en mcp diensten. Het gebundelde Compose-bestand geeft het door aan beide services.
MCP_SERVER_PUBLIC_URL (hierboven ingesteld) stuurt de metagegevens van de MCP-beveiligde bronnen aan. Met de gebundelde docker-compose.yml, worden er automatisch nog twee variabelen afgeleid: MCP_PUBLIC_URL (de canonieke OAuth-bron en het MCP-adres die aan gebruikers worden getoond) van MCP_SERVER_PUBLIC_URLen die van de MCP-service OAUTH_ISSUER_URL van PUBLIC_API_OAUTH_ISSUER.
OAuth-autorisatie- en tokenverzoeken binden elke code, verlenen, vernieuwen familie en toegangstoken aan die canonieke MCP_PUBLIC_URL. Rauw kanera_mcp_... tokens werken alleen op het MCP-eindpunt en worden afgewezen door /api/v1; de MCP-service wisselt ze intern uit voor een afzonderlijke delegatiereferentie van minuten.
Leid de OAuth-detectiepaden naar de juiste service bij uw omgekeerde proxy:
| Pad | Dienst |
|---|---|
/.well-known/oauth-authorization-server, /oauth/* | public-api |
/.well-known/oauth-protected-resource, /.well-known/oauth-protected-resource/mcp, /mcp | mcp |
Bij het upgraden van een release die OAuth-tokens heeft uitgegeven zonder bronbinding, worden bij de migratie bestaande OAuth-toekenningen en -tokens ingetrokken. Geregistreerde clientdefinities blijven bestaan, maar gebruikers en onbeheerde agenten moeten na de oudere migratie één keer opnieuw verbinding maken. De update van het lees-/schrijfbeleid trekt geen geldige OAuth-sessies in en vereist dus geen nieuwe verbinding.
Zie Sluit een AI-agent aan voor de volledige stroom, en Verbind Kanera met uw AI-agent voor clientconfiguratie en MCP-mogelijkheden.
Trello importeren bijlage kopiëren
Trello-bord JSON-import werkt zonder extra instellingen.
Om gebruikers Trello-bestandsbijlagen in Kanera te laten importeren, configureert u een Trello API-sleutel:
TRELLO_API_KEY=your-trello-api-key
Maak de sleutel aan op de Power-Up-beheerpagina van Trello op https://trello.com/power-ups/admin. Er zijn geen opstartmogelijkheden vereist; het Power-Up/app-item is alleen de Trello-container voor de API-sleutel. Gebruikers verbinden Trello tijdens het importeren, zodat Kanera bijlagen voor die import kan kopiëren.