设备

设备代表您的应用程序的单个安装，受 Capgo 管理。设备 API 允许您跟踪和管理设备，包括它们的捆绑包（版本）、频道和更新状态。

数据保留

设备数据保留 90 天 从最后一次设备活动开始。没有连接到 Capgo 的设备将在此期间自动从系统中删除。活动设备将持续跟踪它们检查更新。

了解设备

平台

• : iOS、Android 或 ElectronData Retention
• 版本包 (版本): 当前版本包 (版本) 和原生构建版本
• 环境: 生产环境或开发环境, 模拟器或物理设备
• 频道: 当前更新频道分配
• 自定义 ID: 为自己的跟踪目的而选用的可选标识符

最佳实践

1. 版本包 (版本) 跟踪: 监控设备版本包 (版本) 采用率以确保更新采用
2. 频道管理: 根据测试需求将设备分配到适当的频道
3. 环境感知: 根据环境（prod/dev/emulator）进行适当的处理
4. 自定义识别: 使用自定义 ID 与您的现有系统进行集成

端点

POST

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

将设备链接到特定版本或频道。

请求体

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/

获取设备信息。使用光标分页来高效地检索大型设备列表。

参数

• app_id: 必填。应用程序的 ID
• device_id: 可选。用于获取单个设备的特定设备 ID
• cursor: 可选。用于分页的前一次响应的游标
• limit: 可选。每页显示的设备数量（默认值：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"

响应类型（列表）

当请求多个设备（无参数）： 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 (单个设备)

当请求特定设备时， 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")
}

示例响应（列表）

{
  "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
}

示例响应（单个设备)

{
  "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/

从设备的通道重写中解除设备关联。这会将设备重置为使用其默认通道。

删除设备

设备数据将保留 90天 自上一次设备活动以来。没有连接到Capgo的设备将在此期间自动从系统中删除。活动设备将持续被跟踪，因为它们检查更新。 您无法使用此端点删除设备，它只会影响通道重写。

Query Parameters

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. 原生版本控制: 监控原生应用版本以确保兼容性