API の概要

インストール手順とこのプラグインの全マークダウンガイドを含むセットアップ用の質問をコピーできます。

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

認証

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

例: __CAPGO_KEEP_0__ APIエンドポイントに、__CAPGO_KEEP_1__ APIキーをヘッダーに追加してください。

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:

エンタープライズアカウントの場合、1分あたり1000回のリクエスト
1000 requests per minute for enterprise accounts

If you exceed these limits, you’ll receive a 429 (Too Many Requests) response.

レスポンス形式

すべてのレスポンスはJSON形式です。正常なレスポンスは、オブジェクトまたはフィールドのいずれかを含むことがよくあります。エラーのレスポンスには、エラーの説明が記載されたフィールドが含まれます。 data 成功レスポンスの例: status クリップボードにコピー error エラーのレスポンスの例:

クリップボードにコピー

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

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

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

API キー API キーを生成、リスト、または Capgo API に安全にアクセスするために無効にする

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

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

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

デバイス __CAPGO_KEEP_0__

デバイスアプリケーションバンドルを管理する

ベストプラクティス

: エラーレスポンスを常に確認し適切に処理するリクエスト制限
: リクエスト制限を発生させた場合、指数バックオフを実装するキャッシング
: キャッシュを使用して __CAPGO_KEEP_0__ の呼び出しを最小限に抑える: Cache responses when appropriate to reduce API calls
バージョン管理: APIの変更履歴を追跡することができます。

APIの概要から続けてください。

「__CAPGO_KEEP_0__」を使用している場合 APIの概要 __CAPGO_KEEP_0__の概要を使用して、認証とアカウントフローの計画に役立てることができます。__CAPGO_KEEP_0__を「@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login」「@capgo/capacitor-social-login」における実装の詳細については、@capgo/capacitor-social-loginを参照してください。「@capgo/capacitor-passkey」における実装の詳細については、@capgo/capacitor-passkeyを参照してください。「@capgo/capacitor-native-biometric」における実装の詳細については、@capgo/capacitor-native-biometricを参照してください。 for the implementation detail in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric for the implementation detail in @capgo/capacitor-native-biometric, 2要素認証 for the implementation detail in 2要素認証、と SSO (Enterprise) for the implementation detail in SSO (Enterprise).