Saltare al contenuto
Capgo - Aggiornamenti in tempo reale per le Capacitor App Capgo

Endpoint del canale API

I canali sono un meccanismo di base per la gestione degli aggiornamenti dell'app in Capgo. In modalità auto-hosted, è necessario implementare endpoint dei canali per gestire le assegnazioni dei dispositivi, le query dei canali e le operazioni di gestione dei canali.

Capire i canali

Sezione intitolata “Capire i canali”

I canali ti consentono di:

  • Controllare la distribuzione degli aggiornamentiAssegnare versioni diverse dell'applicazione a diversi gruppi di utenti
  • Test di A/BTestare nuove funzionalità con segmenti di utenti specifici
  • Rilascio gradualeEseguire rilasci di aggiornamenti per minimizzare i rischi
  • Separazione di ambienteSeparare gli aggiornamenti di sviluppo, di staging e di produzione

Configurazione

Sezione intitolata “Configurazione”

Configura l'URL del endpoint del canale nel tuo capacitor.config.json:

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

Operazioni sul canale

Sezione intitolata “Operazioni sul canale”

Il plugin esegue diverse operazioni sul canale che il tuo endpoint deve gestire:

1. Elenco canali compatibili (Richiesta GET)

Sezione intitolata “1. Elenco canali compatibili (Richiesta GET)”

Quando il plugin chiama listChannels(), invia una richiesta GET per recuperare tutti i canali che sono compatibili con il dispositivo. Questo restituisce canali che corrispondono all'ambiente del dispositivo (dev/prod, emulator/real device) e consentono l'accesso pubblico o l'assegnazione di auto.

Formato della richiesta

Sezione intitolata “Formato della richiesta”
// 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 della Risposta

Sezione intitolata “Formato della Risposta”
[
  {
    "id": 1,
    "name": "production",
    "public": true,
    "allow_self_set": false
  },
  {
    "id": 2,
    "name": "beta",
    "public": false,
    "allow_self_set": true
  }
]

Capire i Tipi di Canale

Sezione intitolata “Capire i Tipi di Canale”

La risposta include due bandiere importanti per ogni canale:

  • public: true: Questo è un canale predefinito. I dispositivi non possono assegnarsi automaticamente a esso utilizzando setChannel(). Invece, se un dispositivo rimuove l'assegnazione del canale (utilizzando unsetChannel()), riceverà automaticamente le notifiche da questo canale pubblico se corrisponde alle condizioni del dispositivo.

  • allow_self_set: true: Questo è un canale auto-assegnabile. I dispositivi possono assegnarsi esplicitamente a questo canale utilizzando setChannel(). Ciò è utile per le prove beta, le prove A/B o per consentire agli utenti di optare per specifiche tracce di aggiornamento.

2. Ottieni canale (Richiesta PUT)

Sezione intitolata “2. Ottieni canale (Richiesta PUT)”

Quando il plugin chiama getChannel()Invia una richiesta PUT per recuperare l'assegnazione del canale del dispositivo.

Formato della richiesta

Sezione intitolata “Formato della richiesta”
// 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 della risposta

Sezione intitolata “Formato della risposta”
{
  "status": "ok",
  "channel": "production",
  "allowSet": true,
  "message": "",
  "error": ""
}

3. Imposta il canale (Richiesta POST)

Sezione intitolata “3. Imposta il canale (Richiesta POST)”

Quando il plugin chiama setChannel()invia una richiesta POST per assegnare il dispositivo a un canale specifico.

Formato della richiesta

Sezione intitolata “Formato della richiesta”
// 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 della risposta

Sezione intitolata “Formato della risposta”
{
  "status": "ok",
  "message": "Device assigned to channel successfully",
  "error": ""
}

Casi di errore

Quando un dispositivo tenta di assegnarsi a un

canale pubblico (uno con ), il tuo endpoint dovrebbe restituire un errore: public: trueCopia negli appunti

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

Quando un dispositivo tenta di assegnarsi a un canale che non consente l'assegnazione automatica:

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

4. Rimuovi canale (Richiesta DELETE)

Sezione intitolata “4. Rimuovi canale (Richiesta DELETE)”

Quando il plugin chiama unsetChannel()invia una richiesta DELETE per rimuovere l'assegnazione del canale del dispositivo.

Formato della richiesta

Sezione intitolata “Formato della richiesta”
// 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
}

Esempio di implementazione

Sezione intitolata “Esempio di implementazione”

Ecco un esempio di come implementare l'endpoint del canale in 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"
  }
}

Configurazione del canale

Sezione intitolata “Configurazione del canale”

Il tuo sistema di canali dovrebbe supportare queste opzioni di configurazione:

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
}

Logica di filtraggio del dispositivo

Sezione intitolata “Logica di filtraggio del dispositivo”

Quando si elencano i canali compatibili (richiesta GET), dovresti filtrare i canali in base a queste condizioni:

  1. Verifica della piattaforma: Il canale deve consentire la piattaforma del dispositivo (ios, androidVerifica del tipo di dispositivo electron)
  2. : Il canale deve consentire il tipo di dispositivo (:
    • Se is_emulator=true: Il canale deve avere allow_emulator=true
    • Se is_emulator=false: Il canale deve avere allow_device=true
  3. Verifica tipo di costruzione:
    • Se is_prod=true: Il canale deve avere allow_prod=true
    • Se is_prod=false: Il canale deve avere allow_dev=true
  4. Verifica visibilità: Il canale deve essere o public=true O 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
  })
}

Esempio di schema del database

Sezione intitolata “Esempio di schema del database”

Dovrai memorizzare le configurazioni dei canali e le assegnazioni dei dispositivi:

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

Gestione degli errori

Sezione intitolata “Gestione degli errori”

Gestisci scenari di errore comuni:

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

Prassi raccomandate

Sezione intitolata “Prassi raccomandate”
  1. SicurezzaVerifica tutte le assegnazioni dei canali rispetto alle tue regole aziendali
  2. LoggingRegistra tutte le operazioni dei canali per la revisione e il debug
  3. PerformanceCaching delle configurazioni dei canali per ridurre le query al database
  4. ValidationVerifica l'autenticità di device_id e app_id
  5. Rate LimitingImplementa il limite di tasso per prevenire abusi

Integrazione con gli aggiornamenti

Sezione intitolata “Integrazione con gli aggiornamenti”

Le assegnazioni dei canali lavorano insieme con il tuo Aggiorna API EndpointQuando un dispositivo richiede un aggiornamento, controlla l'assegnazione del canale per determinare quale versione servire:

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

Ciò crea un sistema di gestione dei canali auto-hosted completo che ti consente di avere il pieno controllo su come gli aggiornamenti vengono distribuiti ai tuoi utenti.