OpenAPI の対象ユーザー、推奨される閲読順序、前提条件。
Qoder OpenAPI を使用して、組織レベルでメンバー、グループ、課金グループを管理し、使用量と AI コード指標を取得できます。すべてのエンドポイントには API キー が必要であり、そのキーに紐づいた組織のデータのみにアクセスできます。
サイドバーの アカウント → OpenAPI セクションに従ってください:
Qoder Web コンソールの組織設定または URL から
エラーが発生した場合、レスポンスボディの
対象ユーザー
- 管理者、または外部システムで Teams データを自動取得する必要があるインテグレーション / 運用 / データ担当者。
- HTTPS、JSON、REST に慣れた開発者。
推奨閲覧順序
サイドバーの アカウント → OpenAPI セクションに従ってください:
- 共通仕様 — ベース URL、認証、ページネーション、エラー、命名規則。
- API キーの取得 — コンソールでキーを作成。
- API キーのセキュリティ — 保管、ローテーション、インシデント対応。
- メンバー API — メンバー、統計、クォータ、Add-On Cap。
- グループ API — グループとグループメンバーシップ。
- 課金グループ API — Credits 帰属、グループ上限、メンバー、期間使用量。
- 使用量 API — Credits 使用イベントと集計(メンバー・組織スコープ)。
- AI コード指標 & 追跡 — 集計、コミット帰属、詳細・エクスポート API。
スコープ(概要)
| トピック | 詳細 |
|---|---|
| 認証 | Authorization: Bearer <api_key>;キーは組織に紐づきます。 |
| データスコープ | その組織のデータのみ;エンドポイントごとのフィールド。 |
| ベースパス | ほとんどのルートは /v1/organizations/{organization_id} 配下です(共通仕様を参照)。 |
Organization ID
Qoder Web コンソールの組織設定または URL から organization_id を取得してください。サンプル内のプレースホルダー org_xxx を実際の ID に置き換えてください。
サポート
エラーが発生した場合、レスポンスボディの requestId を記録し、Qoder サポートにお問い合わせください。
