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.

Authentication

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

ターミナル画面

curl -H "authorization: your-api-key" https://api.capgo.app/organization/

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

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

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

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

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

応答フォーマット

すべての応答は JSON 形式です。成功応答は、通常、オブジェクトまたはフィールドを含みます。エラー応答は、エラーの説明を含むフィールドを含みます。 data 成功応答の例: status クリップボードにコピー error 例えば、成功応答は次のようになります。

例えば、成功応答は次のようになります。

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

例外エラー応答:

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

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

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

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

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

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

チャンネル アプリのアップデートチャンネル、バンドル(バージョン)、およびアップデートポリシーを管理する

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

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

ベストプラクティス

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

API の概要から続ける

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