Integrasjoner og APIer
De offentlige API- og MCP-tjenestene er valgfrie. Utsett dem når du vil at eksterne integrasjoner eller AI-klienter skal nå distribusjonen din.
Begge er separate tjenester i komponere filen, slik at du kan legge til enten en senere uten å berøre appen. Tjenester og rute for domener og havner.
Offentlig API
Den offentlige API-tjenesten brukes til integrasjoner, webhooks og API-dokumenter.
Når API-referansen er eksponert, er den tilgjengelig på:
| Sti | Bruk |
|---|---|
/docs | Interaktiv Scalar referanse. |
/swagger | Swagger UI referanse. |
/openapi.json | OpenAPI-dokument for SDK-generering. |
/webhook-event-types | Gjeldende liste over webhook-hendelsestyper denne distribusjonen kan sende. |
For eksempel:
https://api.kanera.example.com/docs
https://api.kanera.example.com/webhook-event-types
Se API for API-nøkler, første forespørsler, webhooks og signaturverifisering.
MCP
MCP-tjenesten lar AI-klienter koble til Kanera over Streamable HTTP.
Når eksponeringen er utsatt, er endepunktet:
https://mcp.kanera.example.com/mcp
Den /health stien er utsatt sammen med den. Kanera viser brukerne den nøyaktige MCP-adressen for å gi sin AI-klient under Profilinnstillinger -> API-nøklerSå, så peker folk der i stedet for å be dem om å sette sammen nettadressen.
Angi den offentlige MCP-URLen når den vises:
MCP_SERVER_PUBLIC_URL=https://mcp.kanera.example.com/mcp
I Docker Compose beholder du den interne MCP-til-offentlig-API-URL-adressen som:
KANERA_PUBLIC_API_URL=http://public-api:3001
MCP-klienter godkjenner med Kanera API-nøkler ved hjelp av:
Authorization: Bearer kanera_live_...
Bruk en personlig nøkkel fra Profilinnstillinger -> API-nøkler for en brukers egen AI-klient på tvers av tilgjengelige tavler. Bruk en arbeidsområdenøkkel fra Arbeidsområdeinnstillinger -> API for delte MCP-klienter eller server-side automatiseringer festet til ett arbeidsområde.
OAuth for AI-agenter
Slik lar du kompatible agenter koble til via en nettleser pålogging i stedet for en API nøkkel, fortell Kanera Dens offentlige OAuth URL-er. Sett publikum API Utsteder på public-api tjeneste:
PUBLIC_API_OAUTH_ISSUER=https://api.kanera.example.com
Generer en egen hemmelighet for den private MCP-til-offentlig-API token utveksling:
MCP_INTERNAL_SECRET=<output of openssl rand -hex 32>
Verdien må være minst 32 tegn, må avvike fra JWT_SECRETog må være identiske i public-api og mcp tjenester. Den medfølgende Compose-filen sender den til begge tjenestene.
MCP_SERVER_PUBLIC_URL (sett over) driver metadataene for MCP-beskyttet ressurs. Med den medfølgende docker-compose.ymlTo variabler blir automatisk utledet: MCP_PUBLIC_URL (den kanoniske OAuth-ressursen og MCP-adressen som vises til brukerne) fra MCP_SERVER_PUBLIC_URLog MCP-tjenestens OAUTH_ISSUER_URL fra PUBLIC_API_OAUTH_ISSUER.
OAuth autorisasjon og token forespørsler binde hver kode, gi, oppdatere familie, og tilgang token til at kanoniske MCP_PUBLIC_URL. Rå kanera_mcp_... tokens fungerer bare på MCP-endepunktet og blir avvist av /api/v1; MCP-tjenesten utveksler dem internt for en egen delegeringslegitimasjon med liten levetid.
Rute OAuth oppdagelsen stier til riktig tjeneste på omvendt proxy:
| Sti | Tjenester |
|---|---|
/.well-known/oauth-authorization-server, /oauth/* | public-api |
/.well-known/oauth-protected-resource, /.well-known/oauth-protected-resource/mcp, /mcp | mcp |
Når du oppgraderer fra en utgivelse som utstedte OAuth-tokener uten ressursbinding, tilbakekaller migreringen eksisterende OAuth-tildelinger og tokener. Registrerte klientdefinisjoner forblir, men brukere og uovervåkede agenter må koble til igjen en gang etter den eldre migreringen. Les / skriv policyoppdateringen tilbakekaller ikke gyldige OAuth-økter, så det krever ikke gjentilkobling.
Se Koble til en AI-agent for full flyt, og Koble Kanera til din AI-agent for klientoppsett og MCP-funksjoner.
Trello importer vedleggskopiering
Trello tavle JSON importerer arbeid uten ekstra oppsett.
Hvis du vil la brukere importere Trello-filvedlegg til Kanera, konfigurerer du en Trello API-nøkkel:
TRELLO_API_KEY=your-trello-api-key
Opprett nøkkelen fra Trello's Power-Up admin side på https://trello.com/power-ups/admin. Ingen Power-Up-funksjoner kreves; Oppføringen for Power-Up / app er bare Trello-beholderen for API-nøkkelen. Brukere kobler Trello under importen, slik at Kanera kan kopiere vedlegg for den importen.