API 概要

このドキュメントは、APIのパブリックCapgoクラウドのAPIです。Capgoリソースの管理をプログラム的に行うことができます。組織、デバイス、チャネル、バンドルを含みます。RESTful設計で標準HTTPメソッドを使用します。

認証

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

例：

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

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

リクエスト制限

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

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

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

Response Format

すべてのレスポンスはJSON形式です。成功したレスポンスは、オブジェクトまたはフィールドのいずれかを含むことがよくあります。エラーのレスポンスは、エラーが発生した理由の説明が含まれるフィールドを含みます。 data 例えば成功したレスポンスの例: status __CAPGO_KEEP_0__ error 例えばエラーのレスポンスの例:

__CAPGO_KEEP_0__

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

「利用可能なエンドポイント」のセクション

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

利用可能なエンドポイントの詳細は、以下のエンドポイントのドキュメントを参照してください。

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

API キー API キーを生成、リスト、または削除して、Capgo API に安全にアクセスする

メンバー 組織のメンバー、ロール、パーミッションを管理する

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

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

デバイス アプリを実行しているデバイスを追跡、管理し、バンドル(バージョン)、チャンネル割り当てを取り扱う

バンドル アプリケーションバンドルのアップロード、リスト、管理などを取り扱います (バージョン)

ベストプラクティス

1. エラーハンドリング: 適切にエラーを処理するために、エラー応答を常に確認する
2. レート制限: レート制限に当たった場合、指数バックオフを実装する
3. キャッシング: キャッシュを適切に使用することで、API の呼び出し数を減らす
4. バージョニング: API の変更履歴を追跡する