統合とAPI
パブリック API および MCP サービスはオプションです。外部統合または AI クライアントをデプロイメントに到達させる必要がある場合に、それらを公開します。
どちらも作成ファイル内の個別のサービスであるため、アプリに触れることなく、後でどちらかを追加できます。参照 サービスとルーティング ドメインとポートの場合。
パブリックAPI
パブリック API サービスは、統合、Webhook、および API ドキュメントに使用されます。
公開されると、API リファレンスは次の場所から入手できます。
| パス | 使用する |
|---|---|
/docs | インタラクティブなスカラー参照。 |
/swagger | Swagger UI リファレンス。 |
/openapi.json | SDK生成用のOpenAPIドキュメント。 |
/webhook-event-types | このデプロイメントが送信できる Webhook イベント タイプの現在のリスト。 |
たとえば:
https://api.kanera.example.com/docs
https://api.kanera.example.com/webhook-event-types
参照 API API キー、最初のリクエスト、Webhook、署名検証用。
MCP
MCP サービスを使用すると、AI クライアントは Streamable HTTP 経由で Kanera に接続できます。
公開されると、エンドポイントは次のようになります。
https://mcp.kanera.example.com/mcp
の /health パスはその横に露出しています。 Kanera は、AI クライアントに与える正確な MCP アドレスをユーザーに示します。 プロファイル設定 -> API キー, そのため、URL を組み立てるように頼むのではなく、そこを人々に示します。
公開するときにパブリック MCP URL を設定します。
MCP_SERVER_PUBLIC_URL=https://mcp.kanera.example.com/mcp
Docker Compose で、内部 MCP-to-public-API URL を次のように保持します。
KANERA_PUBLIC_API_URL=http://public-api:3001
MCP クライアントは、以下を使用して Kanera API キーで認証します。
Authorization: Bearer kanera_live_...
個人キーを使用してください プロファイル設定 -> API キー ユーザー独自の AI クライアントを、アクセス可能なボード全体で利用できます。次のワークスペース キーを使用します。 ワークスペース設定 -> API 共有 MCP クライアントまたは 1 つのワークスペースに固定されたサーバー側オートメーションの場合。
AI エージェント用の OAuth
互換性のあるエージェントが API キーの代わりにブラウザーのサインインを介して接続できるようにするには、Kanera にパブリック OAuth URL を伝えます。パブリック API 発行者を設定します。 public-api サービス:
PUBLIC_API_OAUTH_ISSUER=https://api.kanera.example.com
プライベート MCP からパブリック API へのトークン交換用に別のシークレットを生成します。
MCP_INTERNAL_SECRET=<output of openssl rand -hex 32>
値は少なくとも 32 文字である必要があり、次のものと異なっていなければなりません。 JWT_SECRET、および内で同一である必要があります。 public-api そして mcp サービス。バンドルされた Compose ファイルは、それを両方のサービスに渡します。
MCP_SERVER_PUBLIC_URL (上記で設定) は、MCP で保護されたリソースのメタデータを駆動します。同梱物と docker-compose.yml、さらに 2 つの変数が自動的に導出されます。 MCP_PUBLIC_URL (ユーザーに表示される正規の OAuth リソースと MCP アドレス) MCP_SERVER_PUBLIC_URL、および MCP サービスの OAUTH_ISSUER_URL から PUBLIC_API_OAUTH_ISSUER.
OAuth 認可とトークンリクエストは、すべてのコード、付与、リフレッシュファミリー、およびアクセストークンをその正規にバインドします。 MCP_PUBLIC_URL。生 kanera_mcp_... トークンはMCPエンドポイントでのみ使用でき、次では拒否されます： /api/v1; MCP サービスは、それらを内部で別の分有効の委任資格情報と交換します。
OAuth 検出パスをリバース プロキシの適切なサービスにルーティングします。
| パス | サービス |
|---|---|
/.well-known/oauth-authorization-server, /oauth/* | public-api |
/.well-known/oauth-protected-resource, /.well-known/oauth-protected-resource/mcp, /mcp | mcp |
リソース バインドなしで OAuth トークンを発行したリリースからアップグレードする場合、移行により既存の OAuth 付与とトークンが取り消されます。登録されたクライアント定義は残りますが、ユーザーと無人エージェントは古い移行後に 1 回再接続する必要があります。読み取り/書き込みポリシーの更新では有効な OAuth セッションが取り消されないため、再接続は必要ありません。
参照 AIエージェントを接続する 全体の流れについて、そして Kanera を AI エージェントに接続する クライアントのセットアップと MCP 機能については。
Trello インポート添付ファイルのコピー
Trello ボードの JSON インポートは、追加のセットアップなしで機能します。
ユーザーが Trello 添付ファイルをKanera にインポートできるようにするには、Trello API キーを構成します。
TRELLO_API_KEY=your-trello-api-key
Trello の Power-Up 管理ページからキーを作成します。 https://trello.com/power-ups/admin。パワーアップ機能は必要ありません。 Power-Up/app エントリは、API キーの Trello コンテナーのみです。ユーザーはインポート中に Trello に接続し、Kanera がそのインポートの添付ファイルをコピーできるようにします。
参照 Trello からインポート.