デバイス

Devices represent individual installations of your app that are managed by Capgo. The Devices API allows you to track and manage devices, including their bundles (versions), channels, and update status.

データ保持

データ保持 デバイスデータは from the last device activity. Devices that haven’t connected to Capgo within this period will be automatically removed from the system. Active devices are continuously tracked as they check for updates.

最後のデバイスアクティビティから

デバイスの理解

• 「デバイスの理解」のセクション各デバイスには独自の特性と状態があります：
• バンドル (バージョン): 現在のバンドル (バージョン) とネイティブ ビルド バージョン
• 環境: 製品環境または開発環境、エミュレータまたは物理デバイス
• チャネル: 現在の更新チャネル割り当て
• カスタム ID: 自分のトラッキング用途のためにオプションの識別子

ベスト プラクティス

1. バンドル (バージョン) トラッキング: デバイスのバンドル (バージョン) アドプションを監視して、更新の採用を確実にする
2. チャネル管理: テストのニーズに基づいてデバイスを適切なチャネルに割り当てる
3. 環境認識: 適切にプロダクト/開発者/エミュレータ環境を処理する
4. カスタム識別: 既存システムと統合するためにカスタムIDを使用する

エンドポイント

特定のバンドル(バージョン)またはチャネルにデバイスをリンクする

https://api.capgo.app/device/

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

interface DeviceLink {
  app_id: string
  device_id: string
  version_id?: string // bundle (version) name
  channel?: string    // channel name
}

例のリクエスト

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123",
    "device_id": "device_456",
    "channel": "beta"
  }' \
  https://api.capgo.app/device/

成功応答

{
  "status": "ok"
}

GET

https://api.capgo.app/device/

セクション「GET」

クエリ パラメータ

• app_id: 必須。アプリの ID
• device_id: 任意。特定のデバイス ID を取得するために使用します
• cursor: 任意。前のレスポンスからカーソルを取得するために使用します
• limit: 任意。1 ページあたりのデバイス数 (デフォルト: 50)

例のリクエスト

# Get all devices (first page)
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=app_123"

# Get specific device
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=app_123&device_id=device_456"

# Get next page using cursor
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=app_123&cursor=2024-01-01T00:00:00Z|device_456"

レスポンスのタイプ (リスト)

複数のデバイスを要求する場合 (no device_id parameter):

interface DeviceListResponse {
  data: Device[];
  nextCursor?: string;  // Pass this as 'cursor' param to get next page
  hasMore: boolean;     // true if more pages available
}

interface Device {
  updated_at: string;
  device_id: string;
  custom_id: string;
  version?: number; // bundle (version) id
  version_name: string | null; // bundle (version) name
  channel?: string;
  app_id: string;
  platform: "ios" | "android" | "electron";
  plugin_version: string;
  os_version: string;
  version_build: string;
  is_prod: boolean;
  is_emulator: boolean;
  key_id: string | null; // First 4 chars of encryption key (e.g., "MIIB")
}

Response Type (Single Device)

特定のデバイスを要求する場合、parameter で、デバイス オブジェクトを直接返します: device_id クリップボードにコピー

interface Device {
  updated_at: string;
  device_id: string;
  custom_id: string;
  version?: number; // bundle (version) id
  version_name: string | null; // bundle (version) name
  channel?: string;
  app_id: string;
  platform: "ios" | "android" | "electron";
  plugin_version: string;
  os_version: string;
  version_build: string;
  is_prod: boolean;
  is_emulator: boolean;
  key_id: string | null; // First 4 chars of encryption key (e.g., "MIIB")
}

Example Response (List) のセクション

{
  "data": [
    {
      "device_id": "device_456",
      "custom_id": "test-device-1",
      "version": 1,
      "version_name": "1.0.0",
      "app_id": "app_123",
      "platform": "ios",
      "plugin_version": "5.0.0",
      "os_version": "17.0",
      "version_build": "1",
      "is_prod": true,
      "is_emulator": false,
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "2024-01-01T00:00:00Z|device_456",
  "hasMore": true
}

parameter

{
  "device_id": "device_456",
  "custom_id": "test-device-1",
  "version": 1,
  "version_name": "1.0.0",
  "app_id": "app_123",
  "platform": "ios",
  "plugin_version": "5.0.0",
  "os_version": "17.0",
  "version_build": "1",
  "is_prod": true,
  "is_emulator": false,
  "updated_at": "2024-01-01T00:00:00Z",
  "channel": "production"
}

DELETE

https://api.capgo.app/device/

__CAPGO_KEEP_0__に接続していないデバイスをチャネルオーバーライドから削除します。この操作でデバイスはデフォルトのチャネルに戻されます。

デバイス削除

デバイスデータは 90日 最後のデバイスアクティビティから、デバイスがCapgoに接続していない場合、システムから自動的に削除されます。アクティブなデバイスは、更新をチェックするたびに継続的に追跡されます。

このエンドポイントはデバイスを削除することはできません。ただし、チャネルオーバーライドのみに影響します。

interface Device {
  device_id: string
  app_id: string
}

例のリクエスト

curl -X DELETE \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123",
    "device_id": "device_456"
  }' \
  https://api.capgo.app/device/

成功応答

{
  "status": "ok"
}

エラー処理

一般的なエラーシナリオとその応答:

// Device not found
{
  "error": "Device not found",
  "status": "KO"
}

// Invalid bundle (version)
{
  "error": "Version not found",
  "status": "KO"
}

// Invalid channel
{
  "error": "Channel not found",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage devices",
  "status": "KO"
}

一般的な使用例

1. ベータデバイスの登録

{
  "app_id": "app_123",
  "device_id": "device_456",
  "channel": "beta"
}

2. バージョンオーバーライド

{
  "app_id": "app_123",
  "device_id": "device_456",
  "version_id": "1.1.0"
}

3. デフォルトチャンネルにリセット

// Use DELETE endpoint to remove overrides

デバイス管理のヒント

1. 監視デバイスの状態とバンドル(バージョン)の配布を定期的に確認する
2. テスト: 使いやすいテストデバイスを識別するためにカスタムIDを使用します
3. トラブルシューティング: デバイスのアップデートとチャネル割り当てを追跡します
4. ネイティブバージョン管理: ネイティブアプリのバージョンを監視して互換性を確保します