채널 API 엔드포인트

채널은 Capgo에서 앱 업데이트를 관리하기 위한 핵심 메커니즘입니다. 자체 호스팅 모드에서는 장치 할당, 채널 쿼리 및 채널 관리 작업을 처리하기 위해 채널 끝점을 구현해야 합니다.

채널 이해하기

채널을 사용하면 다음을 수행할 수 있습니다.

• 업데이트 배포 제어: 다양한 사용자 그룹에 다양한 앱 버전 할당
• A/B 테스트: 특정 사용자 세그먼트를 대상으로 새로운 기능 테스트
• 단계적 출시: 점진적으로 업데이트를 배포하여 위험을 최소화합니다.
• 환경 분리: 별도의 개발, 스테이징, 프로덕션 업데이트

구성

capacitor.config.json에서 채널 엔드포인트 URL을 구성합니다.

{
  "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()을 사용하여 자체 할당할 수 없습니다. 대신, 장치가 채널 할당을 제거하는 경우(unsetChannel() 사용) 장치 조건과 일치하는 경우 이 공개 채널에서 자동으로 업데이트를 받습니다.

• allow_self_set: true: 자체 할당 가능한 채널입니다. 장치는 setChannel()을 사용하여 이 채널에 명시적으로 자신을 할당할 수 있습니다. 이는 베타 테스트, A/B 테스트 또는 사용자가 특정 업데이트 트랙을 선택하도록 허용하는 데 유용합니다.

Note

채널은 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
}

응답 형식

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

오류 사례

장치가 공개 채널(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 요청)

플러그인이 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이 있어야 합니다.
   • is_emulator=false인 경우: 채널에는 allow_device=true이 있어야 합니다.
3. 빌드 유형 확인:
   • is_prod=true인 경우: 채널에는 allow_prod=true이 있어야 합니다.
   • 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. 보안: 비즈니스 규칙에 따라 모든 채널 할당을 검증합니다.
2. 로깅: 감사 및 디버깅을 위해 모든 채널 작업을 기록합니다.
3. 성능: 데이터베이스 쿼리를 줄이기 위한 캐시 채널 구성
4. 검증: device_id 및 app_id 진위 여부 확인
5. 속도 제한: 남용을 방지하기 위해 속도 제한을 구현합니다.

업데이트와의 통합

채널 할당은 API 엔드포인트 업데이트와 함께 작동합니다. 기기가 업데이트를 요청하면 채널 할당을 확인하여 어떤 버전을 제공할지 결정하세요.

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

이를 통해 업데이트가 사용자에게 배포되는 방식을 완전히 제어할 수 있는 완전한 자체 호스팅 채널 관리 시스템이 생성됩니다.