Endpoint de canal API

Copia un prompt de configuración con los pasos de instalación y la guía completa en markdown para este plugin.

Los channels son un mecanismo fundamental para gestionar las actualizaciones de apps en Capgo. En modo self-hosted, debes implementar endpoints de channels para gestionar la asignación de dispositivos, consultas de channels y operaciones de gestión de channels.

Entender los Channels

Los canales te permiten:

Controlar la distribución de updates: Asignar distintas versiones a grupos de usuarios
Pruebas A/B: Probar nuevas features con segmentos específicos
Rollouts escalonados: Desplegar updates gradualmente para reducir riesgos
Separación de entornos: Separar updates de dev, staging y producción

Configuración

Configura la URL del endpoint del canal en tu capacitor.config.json:

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

Operaciones de canales

El plugin realiza distintas operaciones de canal que tu endpoint debe gestionar:

1. Listar canales compatibles (GET)

Cuando el plugin llama a listChannels(), envía una petición GET para recuperar todos los canales compatibles con el dispositivo. Esto devuelve los canales que coinciden con el entorno del dispositivo (dev/prod, emulador/dispositivo real) y permiten tanto el acceso público como la autoasignación.

Formato de la petición

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

Formato de respuesta

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

Entender los tipos de canal

La respuesta incluye dos flags importantes para cada canal:

public: true: Este es un canal por defecto. Los dispositivos no pueden autoasignarse a él usando setChannel(). En su lugar, si un dispositivo elimina su asignación de canal (usando unsetChannel()), recibirá automáticamente actualizaciones de este canal público si cumple con las condiciones del dispositivo.
allow_self_set: true: Este es un canal autoasignable. Los dispositivos pueden asignarse explícitamente a este canal usando setChannel(). Esto es útil para beta testing, A/B testing o para permitir que los usuarios elijan tracks de actualización específicos.

2. Obtener canal (PUT)

Cuando el plugin llama a getChannel(), envía una petición PUT para obtener el canal asignado al dispositivo.

Formato de la petición

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

Formato de respuesta

{
  "status": "ok",
  "channel": "production",
  "allowSet": true,
  "message": "",
  "error": ""
}

3. Establecer canal (POST)

Cuando el plugin llama a setChannel(), envía una petición POST para asignar el dispositivo a un canal específico.

Formato de la petición

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

Formato de respuesta

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

Casos de error

Cuando un dispositivo intenta asignarse a un canal público (uno con public: true), tu endpoint debería devolver un error:

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

Cuando un dispositivo intenta asignarse a un canal que no permite la autoasignación:

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

4. Desasignar canal (petición DELETE)

Cuando el plugin llama a unsetChannel(), envía una petición DELETE para eliminar la asignación de canal del dispositivo.

Formato de la petición

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

Ejemplo de implementación

Aquí tienes un ejemplo en JavaScript de cómo implementar el endpoint del canal:

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

Configuración de canales

Tu sistema de canales debe admitir estas opciones de configuración:

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
}

Lógica de filtrado de dispositivos

Al listar los canales compatibles (petición GET), debes filtrar los canales según estas condiciones:

Comprobación de plataforma: El canal debe permitir la plataforma del dispositivo (ios, android, o electron)
Comprobación del tipo de dispositivo:
- Si is_emulator=true: El canal debe tener allow_emulator=true
- Si is_emulator=false: El canal debe tener allow_device=true
Verificación del tipo de build:
- Si is_prod=true: El canal debe tener allow_prod=true
- Si is_prod=false: El canal debe tener allow_dev=true
Verificación de visibilidad: El canal debe ser public=true O BIEN 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
  })
}

Ejemplo de esquema de base de datos

Necesitarás almacenar las configuraciones de los canales y las asignaciones de dispositivos:

-- 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)
);

Manejo de errores

Gestiona los escenarios de error comunes:

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

Buenas prácticas

Seguridad: Valida todas las asignaciones de canales según tus reglas de negocio
Logs: Registra todas las operaciones de canales para auditoría y debugging
Rendimiento: Cachea las configuraciones de canales para reducir las consultas a la base de datos
Validación: Verifica la autenticidad de device_id y app_id
Límites de tasa (Rate Limiting): Implementa rate limiting para prevenir abusos

Integración con Updates

Las asignaciones de canales funcionan junto con tu Endpoint de actualización API. Cuando un dispositivo solicita una actualización, comprueba su canal asignado para determinar qué versión entregar:

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

Esto crea un sistema de gestión de canales self-hosted completo que te da control total sobre cómo se distribuyen las actualizaciones a tus usuarios.

Continuar desde el endpoint de canal API

Si estás usando Endpoint de canal API para planificar el enrutamiento de canales y el despliegue gradual, conéctalo con Al usar @capgo/capacitor-updater para la funcionalidad nativa al usar @capgo/capacitor-updater, Canales para los detalles de implementación en Channels, Canales para los detalles de implementación en Channels, Canales para el detalle de implementación en Channels, y Solución de beta testing para el flujo de trabajo del producto en Beta Testing Solution.