跳过内容
Capgo - 为Capacitor应用提供实时更新 Capgo

API Channel Endpoint

GitHub

频道是 Capgo 中应用更新管理的核心机制。在自托管模式下，您需要实现频道端点来处理设备分配、频道查询和频道管理操作。

了解频道

标题：了解频道

频道允许您：

  • 控制更新分发: 将不同应用版本分配给不同用户组
  • AB 测试: 使用特定用户段测试新功能
  • 分阶段发布: 逐步部署更新以降低风险
  • 环境隔离: 分别隔离开发、测试和生产环境的更新

配置

配置

在您的 capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://myserver.com/api/channel_self"
    }
  }
}

频道操作

频道操作

插件执行的频道操作将由您的端点处理:

1. 列出兼容频道（GET 请求）

1. 列出兼容频道（GET 请求）

当插件调用时 listChannels()它会发送一个 GET 请求以获取与设备兼容的所有通道。这将返回与设备环境（dev/prod、emulator/real device）匹配的通道，并允许公共访问或自我分配。

请求格式

标题：请求格式
// GET /api/channel_self
// Headers:
{
  "Content-Type": "application/json"
}


// Query parameters:
interface ListChannelsRequest {
  app_id: string
  platform: "ios" | "android" | "electron"
  is_emulator: boolean
  is_prod: boolean
  key_id?: string
}

响应格式

标题：响应格式
[
  {
    "id": 1,
    "name": "production",
    "public": true,
    "allow_self_set": false
  },
  {
    "id": 2,
    "name": "beta",
    "public": false,
    "allow_self_set": true
  }
]

了解通道类型

标题：了解通道类型

响应中包含每个通道的两个重要标志：

  • public: true: 这是 默认频道. 设备无法自行将其分配为此频道 setChannel(). 如果设备移除其频道分配（使用 unsetChannel()），它将自动从公共频道接收更新，如果它匹配设备的条件

  • allow_self_set: true: 这是 自分配频道. 设备可以使用 setChannel()explicitly 将自己分配到此频道。 这对于测试、A/B测试或允许用户选择特定更新跟踪非常有用

2. 获取频道 (PUT 请求)

标题为“2. 获取频道 (PUT 请求)”

当插件调用 getChannel()时，它会发送一个 PUT 请求来检索设备的当前频道分配。

请求格式

标题为“请求格式”
// PUT /api/channel_self
// Headers:
{
  "Content-Type": "application/json"
}


// Body:
interface GetChannelRequest {
  device_id: string
  app_id: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
  is_emulator: boolean
  is_prod: boolean
  defaultChannel?: string
  channel?: string  // For newer plugin versions, contains local channel override
}

响应格式

标题为“响应格式”
{
  "status": "ok",
  "channel": "production",
  "allowSet": true,
  "message": "",
  "error": ""
}

3. 设置频道 (POST 请求)

Section titled “3. 设定频道 (POST 请求)””

当插件调用 setChannel()它会发送一个 POST 请求来将设备分配到特定的频道。

请求格式

Section titled “请求格式””
// POST /api/channel_self
interface SetChannelRequest {
  device_id: string
  app_id: string
  channel: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
  is_emulator: boolean
  is_prod: boolean
}

响应格式

Section titled “响应格式””
{
  "status": "ok",
  "message": "Device assigned to channel successfully",
  "error": ""
}

错误案例

Section titled “错误案例””

当设备尝试将自己分配到 公共频道 (一个有 public: true),您的端点应返回错误:

{
  "status": "error",
  "error": "public_channel_self_set_not_allowed",
  "message": "This channel is public and does not allow device self-assignment. Unset the channel and the device will automatically use the public channel."
}

当设备尝试将自己分配到不允许自我分配的频道时:

{
  "status": "error",
  "error": "channel_self_set_not_allowed",
  "message": "This channel does not allow devices to self associate"
}

4. 取消频道分配（DELETE 请求）

标题为“4. 取消频道分配（DELETE 请求）”

当插件调用 unsetChannel()时，它发送一个删除请求来移除设备的频道分配。

请求格式

标题为“请求格式”
// DELETE /api/channel_self
interface UnsetChannelRequest {
  device_id: string
  app_id: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
}

实现示例

名为“实现示例”的部分

以下是 JavaScript 中如何实现渠道端点的示例代码：

interface ChannelRequest {
  device_id: string
  app_id: string
  channel?: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
}


interface ChannelResponse {
  status: "ok" | "error"
  channel?: string
  allowSet?: boolean
  message?: string
  error?: string
}


export const handler = async (event) => {
  const method = event.httpMethod || event.method
  const body = JSON.parse(event.body || '{}') as ChannelRequest


  const { device_id, app_id, channel, platform } = body


  try {
    switch (method) {
      case 'GET':
        return await getDeviceChannel(device_id, app_id)


      case 'POST':
        return await setDeviceChannel(device_id, app_id, channel!, platform)


      case 'DELETE':
        return await unsetDeviceChannel(device_id, app_id)


      default:
        return {
          status: "error",
          error: "Method not allowed"
        }
    }
  } catch (error) {
    return {
      status: "error",
      error: error.message
    }
  }
}


async function getDeviceChannel(deviceId: string, appId: string): Promise<ChannelResponse> {
  // Query your database for device channel assignment
  const assignment = await database.getDeviceChannel(deviceId, appId)


  if (assignment) {
    return {
      status: "ok",
      channel: assignment.channel,
      allowSet: assignment.allowSelfAssign
    }
  }


  // Return default channel if no assignment found
  return {
    status: "ok",
    channel: "production", // Your default channel
    allowSet: true
  }
}


async function setDeviceChannel(
  deviceId: string,
  appId: string,
  channel: string,
  platform: string
): Promise<ChannelResponse> {
  // Validate channel exists and allows self-assignment
  const channelConfig = await database.getChannelConfig(channel, appId)


  if (!channelConfig) {
    return {
      status: "error",
      error: "Channel not found"
    }
  }


  if (!channelConfig.allowDeviceSelfSet) {
    return {
      status: "error",
      error: "Channel does not allow self-assignment"
    }
  }


  // Check platform restrictions
  if (platform === "ios" && !channelConfig.ios) {
    return {
      status: "error",
      error: "Channel not available for iOS"
    }
  }


  if (platform === "android" && !channelConfig.android) {
    return {
      status: "error",
      error: "Channel not available for Android"
    }
  }


  if (platform === "electron" && !channelConfig.electron) {
    return {
      status: "error",
      error: "Channel not available for Electron"
    }
  }


  // Save the assignment
  await database.setDeviceChannel(deviceId, appId, channel)


  return {
    status: "ok",
    message: "Device assigned to channel successfully"
  }
}


async function unsetDeviceChannel(deviceId: string, appId: string): Promise<ChannelResponse> {
  // Remove device channel assignment
  await database.removeDeviceChannel(deviceId, appId)


  return {
    status: "ok",
    message: "Device channel assignment removed"
  }
}

渠道配置

名为“渠道配置”的部分

您的渠道系统应该支持这些配置选项：

interface ChannelConfig {
  name: string
  appId: string


  // Platform targeting
  ios: boolean              // Allow updates to iOS devices
  android: boolean          // Allow updates to Android devices
  electron: boolean         // Allow updates to Electron apps


  // Device type restrictions
  allow_emulator: boolean   // Allow updates on emulator/simulator devices
  allow_device: boolean     // Allow updates on real/physical devices


  // Build type restrictions
  allow_dev: boolean        // Allow updates on development builds (is_prod=false)
  allow_prod: boolean       // Allow updates on production builds (is_prod=true)


  // Channel assignment
  public: boolean           // Default channel - devices fall back to this when no override
  allowDeviceSelfSet: boolean  // Allow devices to self-assign via setChannel()


  // Update policies
  disableAutoUpdate: "major" | "minor" | "version_number" | "none"
  disableAutoUpdateUnderNative: boolean
}

设备过滤逻辑

名为“设备过滤逻辑”的部分

当列出兼容渠道（GET 请求）时，您应该根据以下条件过滤渠道：

  1. 平台检查: 频道必须允许设备的平台 (ios, android, 或 electron)
  2. 设备类型检查:
    • 如果 is_emulator=true: 频道必须有 allow_emulator=true
    • 如果 is_emulator=false: 频道必须有 allow_device=true
  3. 构建类型检查:
    • 如果 is_prod=true: 频道必须有 allow_prod=true
    • __CAPGO_KEEP_0__ is_prod=false: 必须有频道 allow_dev=true
  4. 可见性检查: 频道必须是 public=true 或 allow_device_self_set=true
// Example filtering logic
function getCompatibleChannels(
  platform: 'ios' | 'android' | 'electron',
  isEmulator: boolean,
  isProd: boolean,
  channels: ChannelConfig[]
): ChannelConfig[] {
  return channels.filter(channel => {
    // Platform check
    if (!channel[platform]) return false


    // Device type check
    if (isEmulator && !channel.allow_emulator) return false
    if (!isEmulator && !channel.allow_device) return false


    // Build type check
    if (isProd && !channel.allow_prod) return false
    if (!isProd && !channel.allow_dev) return false


    // Must be accessible (public or self-assignable)
    if (!channel.public && !channel.allowDeviceSelfSet) return false


    return true
  })
}

数据库架构示例

标题为“数据库架构示例”

您需要存储频道配置和设备分配:

-- Channels table
CREATE TABLE channels (
  id SERIAL PRIMARY KEY,
  name VARCHAR(255) NOT NULL,
  app_id VARCHAR(255) NOT NULL,


  -- Platform targeting
  ios BOOLEAN DEFAULT true,
  android BOOLEAN DEFAULT true,
  electron BOOLEAN DEFAULT true,


  -- Device type restrictions
  allow_emulator BOOLEAN DEFAULT true,   -- Allow emulator/simulator devices
  allow_device BOOLEAN DEFAULT true,     -- Allow real/physical devices


  -- Build type restrictions
  allow_dev BOOLEAN DEFAULT true,        -- Allow development builds
  allow_prod BOOLEAN DEFAULT true,       -- Allow production builds


  -- Channel assignment
  public BOOLEAN DEFAULT false,          -- Default channel (fallback)
  allow_device_self_set BOOLEAN DEFAULT false,  -- Allow self-assignment


  -- Update policies
  disable_auto_update VARCHAR(50) DEFAULT 'none',
  disable_auto_update_under_native BOOLEAN DEFAULT false,


  created_at TIMESTAMP DEFAULT NOW(),
  UNIQUE(name, app_id)
);


-- Device channel assignments table
CREATE TABLE device_channels (
  id SERIAL PRIMARY KEY,
  device_id VARCHAR(255) NOT NULL,
  app_id VARCHAR(255) NOT NULL,
  channel_name VARCHAR(255) NOT NULL,
  assigned_at TIMESTAMP DEFAULT NOW(),
  UNIQUE(device_id, app_id)
);

错误处理

标题为“错误处理”

处理常见错误场景:

// Channel not found
{
  "status": "error",
  "error": "Channel 'beta' not found"
}


// Self-assignment not allowed
{
  "status": "error",
  "error": "Channel does not allow device self-assignment"
}


// Platform not supported
{
  "status": "error",
  "error": "Channel not available for this platform"
}


// Invalid request
{
  "status": "error",
  "error": "Missing required field: device_id"
}

最佳实践

最佳实践
  1. 安全性验证所有频道 assignments 与您的商业规则
  2. 日志记录所有频道操作以进行审计和调试
  3. 性能缓存频道配置以减少数据库查询
  4. 验证验证 device_id 和 app_id 真实性
  5. 速率限制: 实现速率限制以防止滥用

与更新的集成

标题：与更新的集成

频道 assignments 与您的 更新 API 接口. 当设备请求更新时，检查其频道 assignments 以确定哪个版本应该提供：

async function getUpdateForDevice(deviceId: string, appId: string) {
  // Get device's channel assignment
  const channelAssignment = await getDeviceChannel(deviceId, appId)
  const channel = channelAssignment.channel || 'production'


  // Get the version assigned to this channel
  const channelVersion = await getChannelVersion(channel, appId)


  return {
    version: channelVersion.version,
    url: channelVersion.url,
    checksum: channelVersion.checksum
  }
}

这创建了一个完整的自托管频道管理系统，使您能够完全控制如何将更新分发给您的用户。

继续从频道 API 接口

标题：继续从频道 API 接口

如果您正在使用 频道 API 接口 为计划频道路由和阶段性发布，连接它与 使用@capgo/capacitor-updater 为@capgo/capacitor-updater中的本地能力 频道 为频道的实现细节 频道 为频道的实现细节 频道 为频道的实现细节， 测试版解决方案 为测试版解决方案中的产品工作流