API 채널 엔드포인트

Capgo에서 앱 업데이트를 관리하는 핵심 메커니즘인 채널은 자체 호스팅 모드에서 구현해야 하는 채널 엔드포인트가 필요합니다. 이 채널 엔드포인트는 장치 할당, 채널 쿼리, 채널 관리 작업을 처리해야 합니다.

채널 이해

채널을 사용하면:

• 업데이트 배포를 제어할 수 있습니다: 사용자 그룹에 다른 앱 버전을 assign 할 수 있습니다
• : 특정 사용자 세그먼트와 함께 새로운 기능을 테스트 할 수 있습니다: 업데이트를 최소한의 위험으로 gradual하게 배포할 수 있습니다
• : 개발, 스테이징 및 프로덕션 업데이트를 분리할 수 있습니다: 구성
• __CAPGO_KEEP_0____CAPGO_KEEP_0__

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__에서 채널 엔드포인트 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
}

__CAPGO_KEEP_1__

[
  {
    "id": 1,
    "name": "production",
    "public": true,
    "allow_self_set": false
  },
  {
    "id": 2,
    "name": "beta",
    "public": false,
    "allow_self_set": true
  }
]

__CAPGO_KEEP_3__

__CAPGO_KEEP_5__

• public: true__CAPGO_KEEP_6__ __CAPGO_KEEP_7____CAPGO_KEEP_8__ setChannel()__CAPGO_KEEP_9__ unsetChannel()__CAPGO_KEEP_10__

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

주의

채널은 public OR allow_self_set, 하지만 일반적으로 둘 중 하나만입니다. 공개 채널은 기본 대체로 사용되며, 자체 할당 채널은 명시적 옵인 요구합니다.

2. 채널 가져오기 (PUT 요청)

플러그인이 호출할 때 getChannel()__CAPGO_KEEP_0__을 위해 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()__CAPGO_KEEP_0__은 기기를 특정 채널에 할당하기 위해 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
}

Response Format

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

Error Cases

장치가 공용 채널에 할당하려고 할 때 공개 채널(( )에 해당하는 채널입니다.) 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."
}

When a device tries to assign itself to a channel that doesn’t allow self-assignment:

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

4. Channel을 해제하는 요청 (DELETE Request)

When the plugin calls unsetChannel(), it sends a DELETE request to remove the device’s channel assignment.

요청 형식

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

구현 예제

Channel을 해제하는 요청 (DELETE Request) 구현 예제 섹션의 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"
  }
}

__CAPGO_KEEP_1__

__CAPGO_KEEP_3__

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
}

__CAPGO_KEEP_4__

__CAPGO_KEEP_6__

1. __CAPGO_KEEP_7____CAPGO_KEEP_8__ios, android__CAPGO_KEEP_9__ electron)
2. __CAPGO_KEEP_10__:
   • If is_emulator=true: 채널은 반드시 allow_emulator=true
   • If is_emulator=false: 채널은 반드시 allow_device=true
3. 빌드 타입 확인:
   • : 채널은 반드시 is_prod=trueIf allow_prod=true
   • : 채널은 반드시 is_prod=falseIf 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. Logging: 모든 채널 연산을 감사 및 디버깅을 위해 로깅합니다.
3. Performance: 채널 구성 설정을 캐시하여 데이터베이스 쿼리 수를 줄입니다.
4. Validation: device_id 및 app_id의 진위성을 검증합니다.
5. Rate Limiting:濫용을 방지하기 위해 속도 제한을 구현합니다.

Integration with Updates

채널 assignments은 사업 규칙과 일치합니다. 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
  }
}

이것은 완전한 자체 호스팅 채널 관리 시스템을 만듭니다. 사용자에게 업데이트가 어떻게 분배되는지에 대한 완전한 제어를 제공합니다.

API 채널 엔드포인트에서 계속

__CAPGO_KEEP_0__ 채널 엔드포인트를 사용하고 있다면 API 채널 엔드포인트 __CAPGO_KEEP_0__ 채널 엔드포인트를 사용하여 채널 라우팅과 스테이지드 롤아웃을 계획하고, 그것을 @capgo/capacitor-업데이터를 사용하여 capgo/capacitor-업데이터를 사용하여 채널 __CAPGO_KEEP_0__ 채널 __CAPGO_KEEP_0__ 채널 __CAPGO_KEEP_0__ 채널에 대한 구현 세부 정보 베타 테스트 솔루션 __CAPGO_KEEP_0__ 베타 테스트 솔루션의 제품 워크플로