채널 API 엔드포인트

채널은 Capgo에서 앱 업데이트를 관리하는 핵심 메커니즘입니다. 자체 호스팅 모드에서, 디바이스 할당, 채널 쿼리 및 채널 관리 작업을 처리하기 위해 채널 엔드포인트를 implement해야합니다.

채널 이해

채널을 통해 다음을 할 수 있습니다:

• 업데이트 배포를 제어할 수 있습니다: 사용자 그룹에 다른 앱 버전을 Assign 할 수 있습니다
• A/B 테스트: 특정 사용자 세그먼트와 함께 새로운 기능을 테스트할 수 있습니다
• 스테이지드 롤아웃: 업데이트를 최소한의 위험으로 점진적으로 배포할 수 있습니다
• 환경 분리: 개발, 스테이징 및 프로덕션 업데이트를 분리할 수 있습니다

설정

채널 엔드포인트 URL을 설정하세요. capacitor.config.json:

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

채널 작업

플러그인은 다음 채널 작업을 수행합니다. 엔드포인트가 처리해야 하는 작업입니다.

1. 호환 가능한 채널 목록 조회 (GET 요청)

플러그인이 호출할 때 listChannels(),

호환 가능한 채널 목록을 조회하기 위해 GET 요청을 보내고, 호환 가능한 채널 목록을 반환합니다. 이 목록은 기기 환경 (개발/운영, 에뮬레이터/실제 기기)과 공공 접근 또는 자체 할당을 허용하는 채널을 포함합니다.

// 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()이 채널 assignment을 사용하여 unsetChannel()장치가 채널 assignment을 제거하는 경우 (

• allow_self_set: true자동으로 이 공개 채널의 업데이트를 받게 됩니다. 만약 장치의 조건과 일치하면. 자체 할당 채널. 장치가 이 채널에 대해 명시적으로 할당할 수 있습니다. setChannel(). 베타 테스트, A/B 테스트 또는 사용자가 특정 업데이트 트랙에 가입할 수 있도록 허용하는 데 유용합니다.

주의

채널은 public 또는 allow_self_set하지만 일반적으로 둘 중 하나가 아닙니다. 공개 채널은 기본 대체로, 자체 할당 채널은 명시적 동의이 필요합니다.

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 요청)

플러그인 호출 시 setChannel()이때 플러그인은 특정 채널에 장치를 할당하기 위해 POST 요청을 보냅니다.

요청 형식

// 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
}

__CAPGO_KEEP_1__

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

__CAPGO_KEEP_3__

__CAPGO_KEEP_5__ __CAPGO_KEEP_6__ __CAPGO_KEEP_7__ public: true__CAPGO_KEEP_8__

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

__CAPGO_KEEP_10__

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

4. 채널 해제 (DELETE Request)

플러그인이 호출할 때 unsetChannel(), 장치의 채널 할당을 삭제하기 위해 DELETE 요청을 보냅니다.

요청 형식

// 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
   • If is_emulator=false: 채널은 반드시 allow_device=true
3. 빌드 타입 확인:
   • If is_prod=true: 채널은 반드시 allow_prod=true
   • If is_prod=false: 채널은 반드시 allow_dev=true
4. 공개 여부 확인: 채널은 반드시 public=true OR 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. 보안: 사업 규칙에 따라 모든 채널 할당을 검증해야 합니다.
2. 로그: 로그를 모두 채널 연산을 감사 및 디버깅을 위해
3. 성능: 채널 구성 설정을 캐시하여 데이터베이스 쿼리 수를 줄입니다
4. 유효성 검사: device_id 및 app_id의 진위성을 확인합니다
5. 속도 제한:濫用 방지를 위해 속도 제한을 구현합니다

업데이트 통합

채널 assignments은 업데이트와 함께 작동합니다 업데이트 API 엔드포인트When a device requests an update, check its channel assignment to determine which version to serve:

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

This creates a complete self-hosted channel management system that gives you full control over how updates are distributed to your users.

Channel API Endpoint에서 계속

If you are using Channel API Endpoint to plan channel routing and staged rollout, connect it with Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater, Channels for the implementation detail in Channels, 채널 채널의 구현 세부 정보에 대한 채널 채널의 구현 세부 정보 및 베타 테스트 솔루션 베타 테스트 솔루션의 제품 워크플로에 대한