Skip to content
Capgo - Live Updates for Capacitor Apps Capgo

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 はすべてのキー種類の推奨ヘッダーであり、安全にハッシュされたキーも含まれます。

リクエスト制限

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

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, or list. この制限は、 アプリ、デバイス、オペレーションにスコープがあります。
  • 同じデバイスを同じチャネルに 60 秒以内に複数回設定すると、429 の応答が返されます。 1 秒あたりの制限がリセットされた後、チャネルを別のチャネルに切り替えることは許可されます。
  • 各アプリと IP アドレスごとに、1 分あたり 1000 のチャネル要求制限が適用されます。

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

レスポンス形式

セクションのタイトル “レスポンス形式”

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

errorField

{
  "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 の変更履歴を通じて 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要素認証 2要素認証の実装詳細について、 SSO (Enterprise) SSO (Enterprise)の実装詳細について。