API の概要

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

This is the documentation of the public API of Capgo cloud. The API allows you to programmatically manage your Capgo resources, including organizations, devices, channels, and bundles. It’s designed to be RESTful and uses standard HTTP methods.

認証

APIのすべてのエンドポイントには認証が必要です。リクエストを認証するには、APIキーをヘッダーに追加してください。 x-api-key Copy a setup prompt with the install steps and the full markdown guide for this plugin.

例:

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

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

その authorization ヘッダーは、レガシーキーである API キーに対してはまだ受け入れられますが、 x-api-key すべてのキー種類、包括してセキュアハッシュキーの場合に推奨されるヘッダーです。

リクエスト制限

API は、公平な利用を確保するためにリクエスト制限を実装しています。現在の制限は:

標準アカウントの場合、1分あたり100回のリクエスト
1000分単位のリクエスト制限

リクエスト数が上限を超えると、429 (Too Many Requests) の応答を受け取ります。

応答フォーマット

すべての応答はJSON形式です。成功応答は、オブジェクトまたはフィールドのいずれかを含みます。エラー応答は、エラーが発生した理由の説明が記載されたフィールドを含みます。 data 成功応答の例: status コピー error エラー応答の例:

コピー

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

__CAPGO_KEEP_0__

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

利用可能なエンドポイント

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

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

メンバー組織メンバー、ロール、パーミッションを管理する

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

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

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

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

ベストプラクティス

エラー処理エラー応答を常に確認し、適切に処理する
レート制限レート制限に当たった場合、指数バックオフを実装する
キャッシング応答をキャッシュすることで、API コールを減らす
バージョニング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 (企業) に参照してください。