API オーバービュー

__CAPGO_KEEP_0__のセットアッププロンプトをコピーします。

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.

__CAPGO_KEEP_0__

すべてのAPIエンドポイントには、APIキーをヘッダーに追加することで、リクエストを認証する必要があります。 x-api-key header.

例:

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

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

この authorization header は、レガシーの API キーに対してはまだ受け入れられますが x-api-key リクエスト制限

「リクエスト制限」セクション

APIは、公平な利用を確保するために、使用回数の制限を実装しています。現在の制限は次のとおりです。

100分間あたり標準アカウントの場合100回の要求
エンタープライズアカウント用に1分あたり1000のリクエスト

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

デバイスチャンネル変更

デバイスチャンネル変更はプラグイン API を使用し、すべてのプラン（試用版を含む）に適用される独自のアブズ・プリスメント制限を持ちます。

デバイスは、各チャンネルオペレーションごとに 1 秒あたり最大 5 のリクエストを実行できます (set, get, delete、または list。) この制限はアプリ、デバイス、オペレーションにスコープがあります。
同じデバイスを 60 秒以内に同じチャンネルに設定すると、429 の応答が返されます。1 秒ごとの制限がリセットされた後は、異なるチャンネルに切り替えることができます。
各アプリと IP アドレスごとに、1 分あたり 1000 のチャンネルリクエストの制限が適用されます。

これらの制限はアカウント全体ではありません。チャンネル切り替えが戻る場合、429 の応答の期間を待ってから再試行してください。 retryAfterSeconds channel changes

レスポンス形式

すべてのレスポンスはJSON形式です。成功したレスポンスは、オブジェクトまたはフィールドのいずれかを含むことがよくあります。エラーの場合は、エラーが発生した理由の説明が含まれるフィールドが含まれます。 data オブジェクトまたはフィールド status エラーの場合は、エラーが発生した理由の説明が含まれるフィールド error 成功した例

コピー

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

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

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

「利用可能なエンドポイント」セクション

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

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

メンバー組織のメンバー、役割、権限を管理する

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

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

デバイスアプリを実行しているデバイスを追跡、管理し、バンドル(バージョン)、チャネル割り当てを取り扱う

パッケージアプリケーションパッケージのアップロード、リスト、管理を取り扱います (バージョン)

ベストプラクティス

エラーハンドリング: すべてのエラー応答を確認し、適切に処理する
レート制限: レート制限に当たった場合、指数バックオフを実装する
キャッシング: キャッシュを使用して、API の呼び出しを最小限に抑える
バージョニング: API の変更を、変更履歴を通じて追跡する

APIの概要から続けて

あなたが「__CAPGO_KEEP_0__の概要から続けて」を使用している場合 「APIの概要から続けて」 authenticationを計画し、会員アカウントのフローを接続するには「@capgo/capacitor-social-login」の実装詳細について「@capgo/capacitor-passkey」の実装詳細について「@capgo/capacitor-native-biometric」の実装詳細について @capgo/capacitor-パスキー実装詳細のために @capgo/capacitor-native-biometric for the implementation detail in @capgo/capacitor-native-biometric, __CAPGO_KEEP_1__はLive Updateに置き換えられます Two-factor authenticationの実装詳細について Enterprise SSO SSO (Enterprise)の実装詳細について