API Overview

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 例:

ターミナル画面

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

APIキーを__CAPGO_KEEP_1__ダッシュボードで生成してください。 Generate your API key in the Capgo dashboard

レガシーキーに対してはヘッダーはまだ受け入れられますが authorization header is still accepted for legacy API keys, but x-api-key はすべてのキー種類の推奨ヘッダー、包括して安全にハッシュされたキーです。

リクエスト制限

はAPIが実装されており、公平な利用を確保するためにリクエスト制限を実行しています。現在の制限は次のとおりです。

• 標準アカウントの場合、1分あたり100のリクエスト
• エンタープライズアカウントの場合、1分あたり1000のリクエスト

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

デバイスチャネル変更

デバイスチャネル変更はプラグインAPIを使用し、すべてのプラン、包括して試用版にも適用される、個別のアブズアブリスク制限を使用します。

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

これらの制限はアカウント全体ではありません。チャネル切り替えが最近選択されたチャネルに戻ることができる場合は、429 の応答の期間を待ってから再試行してください。 retryAfterSeconds リトライするには、チャネル切り替えが最近選択されたチャネルに戻ることができる場合は、429 の応答の期間を待ってから再試行してください。

レスポンス形式

すべてのレスポンスは JSON 形式です。 成功したレスポンスは、オブジェクトまたはフィールドを含むことがよくあります。 エラーのレスポンスは、フィールドとエラーの説明を含むことがよくあります。 data 成功したレスポンスの例: status __CAPGO_KEEP_0__ error __CAPGO_KEEP_1__

__CAPGO_KEEP_2__

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

例外エラーの応答:

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

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

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

API キー API キーを生成、リスト、または Capgo API への安全なアクセスを取り扱う

メンバー 組織メンバー、役割、権限を取り扱う

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

チャンネル Capgoのリリースチャンネル機能名。ページ/エリア: Capgoのソリューションズマーケティングページ。役割: ショートUIラベルまたはナビゲーションアイテム。見られるページ: ソリューションズ/ホワイトラベル.astro。メッセージキー `solutions_white_label_visual_cell2_value` (ソリューションズホワイトラベルビジュアルセル2値)

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

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

アプリのバンドルを取り扱う、アップロード、リスト、バンドル(バージョン)の管理を含む

1. セクションのタイトル「ベストプラクティス」エラー処理
2. : 常にエラー応答を確認し、適切に処理すること。: 速いリクエストの制限を回避するために指数バックオフを実装します。
3. キャッシュ: 適切な場合にレスポンスをキャッシュして API の呼び出し数を減らします。
4. バージョニング: API の変更を追跡するために、変更履歴を参照してください。

Keep going from API Overview

Capgo を使用している場合 API Overview 認証とアカウントフローの計画に使用する場合、Capgo を @__CAPGO_KEEP_1__-social-login に接続してください。 @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey @capgo/capacitor-passkeyの実装詳細について @capgo/capacitor-native-biometric @capgo/capacitor-native-biometricの実装詳細について 2要素認証 2要素認証の実装詳細について、 SSO (Enterprise) SSO (Enterprise)の実装詳細について。