Skip to main content
OpenAPI

OpenAPI 概要

OpenAPI の対象ユーザー、推奨される閲読順序、前提条件。

Qoder OpenAPI を使用して、組織レベルでメンバー、グループ、課金グループ、モデルの表示範囲を管理し、使用量と AI コード指標を取得できます。組織のエンドポイントには API キー が必要であり、そのキーに紐づいた組織のデータのみにアクセスできます。 ドメインと送信元 IPは認証不要で、API キーも組織 ID も必要ありません。現在の環境の Qoder アクセスドメインと送信元パブリック IP を取得し、ファイアウォールや IP／ドメインの許可リストを設定できます。

対象ユーザー

  • 管理者、または外部システムで Teams データを自動取得する必要があるインテグレーション / 運用 / データ担当者。
  • HTTPS、JSON、REST に慣れた開発者。

推奨閲覧順序

サイドバーの アカウント → OpenAPI セクションに従ってください：
  1. 共通仕様 — ベース URL、認証、ページネーション、エラー、命名規則。
  2. API キーの取得 — コンソールでキーを作成。
  3. API キーのセキュリティ — 保管、ローテーション、インシデント対応。
  4. メンバー API — メンバー、招待、統計、クォータ、Add-On Cap。
  5. グループ API — グループとグループメンバーシップ。
  6. 課金グループ API — Credits 帰属、グループ上限、メンバー、期間使用量。
  7. モデル API — モデルのレベル、新モデル、グループ単位の表示範囲。
  8. 使用量 API — Credits 使用イベントと集計（メンバー・組織スコープ）。
  9. AI コード指標 & 追跡 — 集計、コミット帰属、詳細・エクスポート API。

組織のエンドポイントのスコープ（概要）

トピック詳細
認証Authorization: Bearer <api_key>；キーは組織に紐づきます。
データスコープその組織のデータのみ；エンドポイントごとのフィールド。
ベースパスほとんどのルートは /v1/organizations/{organization_id} 配下です（共通仕様を参照）。
API キーは、製品の権限モデル内で作成者とほぼ同じアクセス権限を持ちます。キーをリポジトリ、チャット、メールに貼り付けないでください。

Organization ID

組織のエンドポイントを呼び出す場合は、Qoder Web コンソールの組織設定または URL から organization_id を取得してください。サンプル内のプレースホルダー org_xxx を実際の ID に置き換えてください。

サポート

エラーが発生した場合、レスポンスボディの requestId を記録し、Qoder サポートにお問い合わせください。