用途に応じて連携方式と呼び出し主体を選び、サービスアカウントの設定と必要な業務機能を追加します。
Qoder Agent SDK を使うと、自社アプリ、社内ツール、自動化サービスでタスクを受け付け、業務ツールを呼び出して結果を返せます。機能と実行の仕組みは概要と動作の仕組みを参照してください。
目的に合う連携方式を選び、リンク先の手順に進んでください。
必要な機能を組み合わせてください。すべてを導入する必要はありません。
個人アクセストークン(PAT)は Qoder ユーザーを表します。そのユーザーの権限やデータを必要とするスクリプト、CI、アプリで使用します。開発用ワークステーションでは、Qoder CLI のログイン状態を再利用することもできます。自動化サービスでは認証情報を明示的に設定してください。
サービスアカウント(Service Account、SA)は、組織内の独立したアプリ用 ID です。個人アカウントに依存させたくないバックエンドサービス、CI、定期ジョブに適しています。業務ユーザーは引き続きアプリのアカウントでログインするため、全員が Qoder アカウントを作る必要はありません。ユーザー認証とタスクの実行権限はアプリで管理します。メンバーとロールとサービスアカウントを参照してください。
以下の順に設定します。設定済みの項目は再利用できます。サブスクリプション、課金、サービスアカウント、認証情報は、同じ対象組織にそろえてください。
対象組織に有効な Teams または Enterprise サブスクリプションがあり、クラウドマーケットプレイスの引き換えコードで作成された組織であることを確認します。サービスアカウントの利用前提条件を確認してください。組織の作成と購入は引き換えコードの説明、プランと価格は料金案内を参照してください。
JavaScript/TypeScript(Node.js)、Python、Java のいずれかを選び、インストール手順に従います。認証には以下のどちらかを使用します。
必要な機能を組み合わせてください。設定方法はリンク先のドキュメントを参照してください。
サービスアカウントで連携する場合は不要です。業務ユーザーはアプリのアカウントを使用し、サービスアカウントがアプリに代わって Qoder にアクセスします。ログイン、データへのアクセス権限、タスクの実行権限はアプリ側で管理します。組織のアプリケーションを参照してください。
まず組織が利用前提条件を満たすことを確認し、専用 Credits を購入・引き換えて、残高が利用可能になったことを確認してください。その後、サービスアカウントと認証情報を作成し、SDK を設定します。サービスアカウントで連携を始めるに従って進めてください。
必ず成功するとは限りません。開始前の業務上の確認は、タスクを開始するかどうかを決めるものです。その後の呼び出しでも、認証情報、専用 Credits 残高、アカウントの利用上限の条件を満たす必要があります。
プロジェクトファイルにアクセスでき、プロジェクトのディレクトリ構成に一貫性がある必要があります。外部セッションストレージはワークスペースを移行しません。
自動的には分かれません。プラットフォームは引き続きサービスアカウントと所属組織の消費量を記録します。業務ユーザーとの関連付けや配賦・記帳はアプリ側で行います。これによってプラットフォームの使用量の帰属や Credits パックの注文の帰属が自動的に変わることはありません。
連携シナリオ
目的に合う連携方式を選び、リンク先の手順に進んでください。
| 実現したいこと | 連携方式 | 参照先 |
|---|---|---|
| 独自の Agent アプリを開発する、または既存製品に Agent 機能を追加する | デスクトップアプリ、Web バックエンド、開発ツールに SDK を組み込む | 呼び出し主体を選ぶ、連携手順 |
| 既存の業務フローに Agent を組み込み、タスクを自動化する | スクリプト、ジョブサービス、パイプラインから SDK を呼び出す | 連携手順、業務機能の追加 |
| ユーザー別の使用量を集計する、または権限・プラン・残高に応じて利用を制限する | 使用量を業務ユーザーに関連付け、必要に応じてタスク開始前に確認する | 使用量の関連付けと実行可否の確認 |
呼び出し主体を選ぶ
個人としての呼び出し
個人アクセストークン(PAT)は Qoder ユーザーを表します。そのユーザーの権限やデータを必要とするスクリプト、CI、アプリで使用します。開発用ワークステーションでは、Qoder CLI のログイン状態を再利用することもできます。自動化サービスでは認証情報を明示的に設定してください。
組織のアプリケーション
サービスアカウント(Service Account、SA)は、組織内の独立したアプリ用 ID です。個人アカウントに依存させたくないバックエンドサービス、CI、定期ジョブに適しています。業務ユーザーは引き続きアプリのアカウントでログインするため、全員が Qoder アカウントを作る必要はありません。ユーザー認証とタスクの実行権限はアプリで管理します。メンバーとロールとサービスアカウントを参照してください。
配置に応じた認証情報の管理
- 信頼できるバックエンドで SDK を実行する場合:バックエンドで SA Key を保管し、SDK に直接渡します。SDK が短期トークン(SAT)を取得・更新します。
- クライアントアプリや認証情報を集中管理する場合:SA Key は信頼できるサーバーで保管し、業務ユーザーを確認してから SAT と交換します。ホストアプリが SAT を提供・更新します。配布するクライアントアプリに SA Key を含めないでください。
サービスアカウントで連携を始める
以下の順に設定します。設定済みの項目は再利用できます。サブスクリプション、課金、サービスアカウント、認証情報は、同じ対象組織にそろえてください。
手順 1:組織とサブスクリプションの購入経路を確認する
対象組織に有効な Teams または Enterprise サブスクリプションがあり、クラウドマーケットプレイスの引き換えコードで作成された組織であることを確認します。サービスアカウントの利用前提条件を確認してください。組織の作成と購入は引き換えコードの説明、プランと価格は料金案内を参照してください。
手順 2:サービスアカウント専用 Credits を購入・引き換える
- 購入と引き換えの説明に従い、Alibaba Cloud International Marketplaceでサービスアカウント専用 Credits パックを購入します。
- 組織管理者として Organization Settings > Organization Usage > Redeem credits pack を開き、対象組織で引き換えます。残高が利用可能になったことを確認してください。
手順 3:サービスアカウントと認証情報を作成する
- 組織管理者がアプリ用のサービスアカウントを作成し、必要に応じて専用 Credits の利用上限を設定します。
- サービスアカウント認証の準備事項に従って SA Key を生成し、信頼できるサーバー側のシークレット管理ツールに保管します。
手順 4:SDK をインストールして認証を設定する
JavaScript/TypeScript(Node.js)、Python、Java のいずれかを選び、インストール手順に従います。認証には以下のどちらかを使用します。
- 信頼できるバックエンドで SDK を実行する場合:SA Key を直接渡す。
- クライアントアプリや認証情報を集中管理する場合:ホストアプリが SAT を提供・更新する。
手順 5:タスクを実行して使用量を確認する
- クイックスタートに従って最初のタスクを実行します。手順 4 のサービスアカウント認証を使用し、作業ディレクトリとツールの権限を指定してください。
- 最終結果を受け取ったら、エラーとエラーコードでタスクの状態を確認し、コストと使用量を確認します。
- 組織の使用量でサービスアカウントの消費量と専用 Credits 残高を確認します。注文と支払いは企業向け料金案内に従い、マーケットプレイスのアカウントで確認してください。
業務に応じた機能の追加
必要な機能を組み合わせてください。設定方法はリンク先のドキュメントを参照してください。
| 業務上の要件 | 連携方式とドキュメント |
|---|---|
| 業務データや社内システムにアクセスする | カスタムツール、MCP |
| 業務上の役割、チームの規則、作業方法を指定する | システムプロンプト、Skills |
| 専門の役割を分担させる、拡張機能をまとめて配布する | Subagents、Plugins |
| 操作を承認する、実行前後の検証や監査を行う | 権限管理、Hooks |
| 複数インスタンス間でセッションを復元する | 外部セッションストレージ |
| 過去の経験を再利用する、ファイルの状態を復元する | メモリ、ファイルスナップショットと巻き戻し |
| モデルの利用方針を設定する、コードの安全性を確認する | モデル選択、セキュリティスキャン |
| ユーザーや顧客ごとの消費量を集計する | ユーザー・タスク・セッションを対応付け、コストと使用量を取得して業務側で記帳する |
| 権限、プラン、残高に応じて利用を制限する | アプリで利用権限を確認し、許可された場合にタスクを開始する。許可されない場合は理由を返す。Qoder も認証情報とプラットフォーム上の制限を確認する |