コンテンツにジャンプ
Capgo - Capacitor Live Updates Capgo

API の概要

このドキュメントは、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キーを取得 APIキーをCapgoダッシュボードで生成してください

ヘッダは、すべてのキー種類、包括安全ハッシュされたキーに対して推奨されるヘッダです。 authorization header is still accepted for legacy API keys, but x-api-key レート制限に関するセクションのタイトルです。']} ]}

Rate Limiting

Section titled “Rate Limiting”

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

  • 1分あたり100のリクエストが標準アカウント用に許可されています。
  • 1分あたり1000のリクエストがエンタープライズアカウント用に許可されています。

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

デバイスチャネル変更

「デバイスチャネル変更」セクション

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

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

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

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__ data __CAPGO_KEEP_0__ status __CAPGO_KEEP_0__ error __CAPGO_KEEP_0__

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

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

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

「利用可能なエンドポイント」セクション
組織 組織を作成、管理し、設定を更新し、組織レベルの構成を取り扱う
API キー 安全な Capgo API へのアクセス用に API キーを生成、リスト、削除する
メンバー 組織メンバー、ロール、パーミッションを取り扱う
統計 アプリの使用状況、ストレージ、帯域幅消費量に関する詳細な分析にアクセスする
チャンネル アプリの更新チャンネル、バンドル(バージョン)、更新ポリシーを制御する
デバイス あなたのアプリを実行しているデバイスを追跡および管理し、バンドル（バージョン）およびチャネル割り当てを含む
バンドル アプリのバンドルを取り扱い、アップロード、リスト、バンドル（バージョン）を管理する

ベスト プラクティス

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

APIの概要から進めます

APIの概要から進むセクション

Capgoを使用している場合 APIの概要 認証とアカウントフローの計画に使用する場合、__CAPGO_KEEP_0__ Overviewを @capgo/capacitor-social-login @capgo/capacitor-social-loginの実装詳細については、@capgo/capacitor-social-loginを参照してください @capgo/capacitor-passkey @capgo/capacitor-passkeyの実装詳細については、@capgo/capacitor-passkeyを参照してください @capgo/capacitor-native-biometric @capgo/capacitor-native-biometricの実装詳細 Two-factor authentication @__CAPGO_KEEP_0__の実装詳細とTwo-factor authentication、 SSO (Enterprise) @__CAPGO_KEEP_0__の実装詳細とSSO (Enterprise).