API の概要

__CAPGO_KEEP_0__のセットアッププロンプトをコピーします。インストール手順とこのプラグインのフルマークダウンガイドを含みます。

Capgoクラウドの公開APIのドキュメントです。APIは、組織、デバイス、チャネル、バンドルなどのCapgoリソースをプログラムで管理することを可能にします。RESTful設計で標準HTTPメソッドを使用しています。

認証

APIのすべてのエンドポイントは認証が必要です。リクエストを認証するには、APIキーをヘッダーに追加してください。 x-api-key __CAPGO_KEEP_1__キー

例:

curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

API キーを取得 API キーを Capgo ダッシュボードで生成する

この authorization header is still accepted for legacy API keys, but x-api-key リクエスト制限

The API implements rate limiting to ensure fair usage. Current limits are:

__CAPGO_KEEP_0__ を超えると、429 (Too Many Requests) の応答を受け取ります。

すべての応答は JSON 形式です。成功応答は、オブジェクトまたはフィールドを含むことがよくあります。エラー応答は、エラーが発生した理由の説明が記載されたフィールドを含みます。 data 成功応答の例: status __CAPGO_KEEP_1__ error エラー応答の例:

__CAPGO_KEEP_2__

{
  "status": "ok",
  "data": { ... }
}

__CAPGO_KEEP_4__

{
  "error": "Invalid API key",
  "status": "KO"
}

組織組織を作成、管理し、設定を更新し、組織レベルの構成を取り扱う

API キー安全な Capgo API へのアクセス用に API キーを生成、リスト、削除する

メンバー組織メンバー、ロール、パーミッションを取り扱う

統計アプリの使用状況、ストレージ、帯域幅消費に関する詳細な分析にアクセスする

チャンネルアプリの更新チャンネル、バンドル(バージョン)、更新ポリシーを制御する

デバイスあなたのアプリを実行しているデバイスを追跡および管理し、バンドル（バージョン）およびチャンネル割り当てを含む

バンドルアプリのバンドルを取り扱い、アップロード、リスト、バンドル（バージョン）を管理する

Capacitorを使用している場合 APIの概要 Capacitorを使用して認証とアカウントフローの計画を行っている場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login Capacitorを使用して認証とアカウントフローの計画を行っている場合、@capgo/capacitor-social-loginの実装詳細については、@capgo/capacitor-social-loginを参照してください。 Capacitorを使用して認証とアカウントフローの計画を行っている場合、@capgo/capacitor-passkey Capacitorを使用して認証とアカウントフローの計画を行っている場合、@capgo/capacitor-passkeyの実装詳細については、@capgo/capacitor-passkeyを参照してください。 Capacitorを使用して認証とアカウントフローの計画を行っている場合、@capgo/capacitor-native-biometric Capacitorを使用して認証とアカウントフローの計画を行っている場合、@capgo/capacitor-native-biometricの実装詳細については、@capgo/capacitor-native-biometricを参照してください。実装詳細の詳細については @capgo/capacitor-native-biometric に参照してください。 2要素認証実装詳細の詳細については 2要素認証、 SSO (企業) 実装詳細の詳細については SSO (企業) に参照してください。