APIの概要

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

認証

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

例:

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

APIキーを取得 CapgoダッシュボードでAPIキーを生成

APIは公平な使用を保証するためにレート制限を実装しています。現在の制限は:

これらの制限を超えると、429 (Too Many Requests)レスポンスが返されます。

すべてのレスポンスはJSON形式です。成功レスポンスには通常、dataオブジェクトまたはstatusフィールドが含まれます。エラーレスポンスには、何が問題だったかの説明を含むerrorフィールドが含まれます。

成功レスポンスの例:

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

エラーレスポンスの例:

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

組織組織を作成および管理し、設定を更新し、組織レベルの構成を処理

APIキー Capgo APIへの安全なアクセスのためのAPIキーの生成、リスト、取り消し

メンバー組織メンバー、ロール、権限の管理

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

チャネルアプリの更新チャネル、バージョン、更新ポリシーの制御

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

バンドルアップロード、リスト、バージョン管理など、アプリバンドルの処理