API Overview

インストール

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

認証

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

The 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分あたり100のリクエスト
エンタープライズアカウントの場合、1分あたり1000のリクエスト

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

デバイスチャネル変更

Device channel changes use the plugin API and have separate abuse-prevention limits that apply to every plan, including trials:

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

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

応答フォーマット

すべての応答は JSON 形式です。成功した応答は、オブジェクトまたはフィールドを含むことがよくあります。エラー応答は、エラーが何が原因で発生したかを記載したフィールドを含みます。 data 成功した応答の例: status object error field

error

{
  "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 2要素認証 Capgo 2要素認証 SSO (Enterprise)