API アサター

インストール

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

認証

All API endpoints require authentication. To authenticate your requests, add your API key in the x-api-key 例:

ターミナル画面

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

Get API key Generate your API key in the Capgo dashboard

レガシーキーは__CAPGO_KEEP_0__でなければなりません authorization API x-api-key はすべてのキー型の推奨ヘッダーであり、安全にハッシュされたキーも含まれます。

リクエスト制限

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

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

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

デバイスチャネル変更

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

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

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

「応答フォーマット」のセクション

成功応答の例: data object or a status field. Error responses include an error field with a description of what went wrong.

Example success response:

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

例のエラー応答:

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

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

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

API キー API キーを生成、リスト、削除し、Capgo API への安全なアクセスを取り扱う

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

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

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

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

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

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

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

API の概要から続ける

__CAPGO_KEEP_0__ を使用している場合 API の概要 __CAPGO_KEEP_0__ を使用して、認証とアカウントフローの計画を行っている場合、 __CAPGO_KEEP_0__ を __CAPGO_KEEP_1__-social-login に接続する capgo/capacitor-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 郹事認证計读郹事認证計读、エコターバートエコターバート、