Canales

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

Los canales son la mecánica fundamental para gestionar las actualizaciones de la aplicación en Capgo. Permiten controlar cómo y cuándo los usuarios reciben actualizaciones, habilitando características como pruebas A/B, despliegues escalonados y actualizaciones específicas de plataforma.

Entendiendo los canales

Un canal representa un track de distribución para las actualizaciones de la aplicación. Cada canal puede configurarse con reglas y restricciones específicas:

Control de paquete (versión)Specifique qué paquete (versión) reciben los usuarios
Configuración de plataforma: Seleccionar plataformas específicas (iOS/Android/Electron)
Políticas de actualización: Controlar cómo se entregan las actualizaciones
Restricciones de dispositivo: Administrar qué dispositivos pueden acceder a las actualizaciones

Opciones de configuración de canal

público: Establecer como canal predeterminado para nuevos dispositivos.
desactivarActualizacionesAutomáticasBajoAplicaciónNativa: Evitar actualizaciones cuando la versión nativa de la aplicación del dispositivo es más reciente que la versión estable del canal.
desactivarActualizacionesAutomaticas: Controlar el comportamiento de la actualización (major, minor, metadata, patch, o none).
actualizarPaquete: Controlar si los dispositivos descargan un zip, un delta o ambos (all, zip, delta, zip_from_builtin, o delta_from_builtin). Consulte Paquete de actualización.
ios/android/electron: Habilitar o deshabilitar la entrega por plataforma.
permitirQueLosDispositivosEligenSuCanal: Dejar que los dispositivos elijan su canal.
allow_emulator, allow_device, allow_dev, allow_prod: Controlar qué dispositivos y tipos de compilación reciben actualizaciones.
Despliegue progresivo: Mantenga una versión estable del paquete mientras expone una versión objetivo a un grupo cohesivo. Consulte Despliegues progresivos.

Prácticas recomendadas

Canales de pruebas: Mantenga un canal de pruebas para la validación interna
Despliegue de Etapa: Utilice múltiples canales para el despliegue de actualizaciones de forma gradual
Separación de Plataforma: Cree canales separados para iOS, Android y Electron cuando sea necesario
Control de Paquete (versión): Utilice versión semántica para rutas de actualización claras

Puntos de Acceso

POST

https://api.capgo.app/channel/

Crear o actualizar una configuración de canal.

Cuerpo de la solicitud

type DisableAutoUpdate = "major" | "minor" | "metadata" | "patch" | "none"
type AutoPauseAction = "pause" | "rollback" | "notify"

interface ChannelSet {
  app_id: string
  channel: string
  version?: string | null // stable bundle name
  public?: boolean
  disableAutoUpdateUnderNative?: boolean
  disableAutoUpdate?: DisableAutoUpdate
  updatePackage?: "all" | "zip" | "delta" | "zip_from_builtin" | "delta_from_builtin"
  ios?: boolean
  android?: boolean
  electron?: boolean
  allow_device_self_set?: boolean
  allow_emulator?: boolean
  allow_device?: boolean
  allow_dev?: boolean
  allow_prod?: boolean

  // Progressive rollout (camelCase is preferred)
  rolloutVersion?: string | number | null // target bundle name or ID
  rolloutPercentage?: number // 0–100
  rolloutPercentageBps?: number // 0–10000; takes precedence when both are set
  rolloutEnabled?: boolean
  rolloutPaused?: boolean // input-only convenience flag
  rolloutPausedAt?: string | null // ISO timestamp or null
  rolloutPauseReason?: string | null
  rolloutCacheTtlSeconds?: number // 60–31536000
  rollback?: boolean
  promoteToStable?: boolean

  // Rollout auto-pause policy
  autoPauseEnabled?: boolean
  autoPauseWindowMinutes?: number
  autoPauseFailureRateBps?: number | null
  autoPauseConfidence?: number
  autoPauseMinAttempts?: number | null
  autoPauseMinFailures?: number | null
  autoPauseAction?: AutoPauseAction
  autoPauseCooldownMinutes?: number
}

For rollout and auto-pause fields, the API also accepts the equivalent snake_case o rollout_version o auto_pause_enabled. updatePackage también acepta update_packagetambién acepta la forma equivalente rollback si se proporcionan ambos formatos, el valor camelCase gana.

es camelCase solo. version Un objetivo de lanzamiento requiere un canal existente. Debe tener un paquete estable asignado ya sea mediante una asignación previa o mediante una asignación en la misma solicitud POST. rollback y promoteToStable son acciones de terminal; no las combinen entre sí.

Ejemplo de solicitud

Configura un despliegue del 5% para un canal existente cuya biblioteca estable ya está configurada: production Ventana de terminal

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "com.example.app",
    "channel": "production",
    "rolloutVersion": "1.3.0",
    "rolloutPercentage": 5,
    "rolloutEnabled": true,
    "rolloutCacheTtlSeconds": 2592000,
    "autoPauseEnabled": true,
    "autoPauseFailureRateBps": 500,
    "autoPauseMinAttempts": 100,
    "autoPauseAction": "pause"
  }' \
  https://api.capgo.app/channel/

Sección titulada “Respuesta de éxito”

{
  "status": "ok"
}

Copy to clipboard

App Preview key boundary

Para una vista previa de PR con privilegios mínimos, autenticar este punto de conexión con authorization: $CAPGO_API_KEY o capgkey: $CAPGO_API_KEYLa x-api-key El encabezado no se acepta por los canales API.

Un app_preview Una clave puede crear un canal de vista previa no público. La creación da automáticamente a esa clave una vinculación de ciclo de vida del canal para ese canal solo. El rol no incluye channel.update_settings, por lo que no puede usar POST para actualizar un canal existente, incluido un canal existente por defecto o principal.

Dejar public sin establecer (o establecerlo en) falseUsar bundle upload --channel para la creación y subida en lugar de tratar a POST como una vista previa de canal general upsert.

GET

https://api.capgo.app/channel/

Obtener información de canal. Devuelve 50 canales por página. Sin channel, la respuesta es un array. Con channel, la respuesta es un objeto de canal único.

Parámetros de consulta

app_id: Obligatorio. El ID de su aplicación
page: Opcional. Número de página para paginación
channel: Opcional. Nombre de canal específico para recuperar

Solicitudes de ejemplo

# Get all channels
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/channel/?app_id=com.example.app"

# Get a specific channel
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/channel/?app_id=com.example.app&channel=production"

# Get the next page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/channel/?app_id=com.example.app&page=1"

Tipo de respuesta

interface Channel {
  id: number
  created_at: string
  updated_at: string
  name: string
  app_id: string
  created_by: string
  public: boolean
  disableAutoUpdateUnderNative: boolean
  disableAutoUpdate: DisableAutoUpdate
  updatePackage: "all" | "zip" | "delta" | "zip_from_builtin" | "delta_from_builtin"
  allow_device_self_set: boolean
  allow_emulator: boolean
  allow_device: boolean
  allow_dev: boolean
  allow_prod: boolean
  version: { id: number, name: string } | null // stable bundle

  // These three response identifiers intentionally use snake_case.
  rollout_version: number | null
  rollout_id: string
  rollout_version_info: { id: number, name: string } | null

  rolloutPercentageBps: number
  rolloutEnabled: boolean
  rolloutPausedAt: string | null
  rolloutPauseReason: string | null
  rolloutCacheTtlSeconds: number
  autoPauseEnabled: boolean
  autoPauseWindowMinutes: number
  autoPauseFailureRateBps: number | null
  autoPauseConfidence: number
  autoPauseMinAttempts: number | null
  autoPauseMinFailures: number | null
  autoPauseAction: AutoPauseAction
  autoPauseCooldownMinutes: number
  autoPauseLastTriggeredAt: string | null
  autoPauseLastCheckedAt: string | null
}

rolloutPaused Es un atajo de solo entrada y no se devuelve. Una pausa de lanzamiento se representa con un valor no nulo de rolloutPausedAt.

Respuesta de ejemplo

[
  {
    "id": 1,
    "name": "production",
    "app_id": "com.example.app",
    "updatePackage": "all",
    "version": { "id": 1, "name": "1.2.0" },
    "rollout_version": 2,
    "rollout_id": "e60c19c9-2e65-4e0d-bc06-d1f5b4f96276",
    "rollout_version_info": { "id": 2, "name": "1.3.0" },
    "rolloutPercentageBps": 500,
    "rolloutEnabled": true,
    "rolloutPausedAt": null,
    "rolloutCacheTtlSeconds": 2592000,
    "autoPauseEnabled": true,
    "autoPauseFailureRateBps": 500,
    "autoPauseAction": "pause"
  }
]

Eliminar

https://api.capgo.app/channel/

Eliminar un canal. Tenga en cuenta que esto afectará a todos los dispositivos que utilicen este canal.

Cuerpo de la solicitud

interface Channel {
  channel: string
  app_id: string
  delete_bundle?: boolean // also delete the linked bundle
}

Solicitud de ejemplo

curl -X DELETE \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "app_id": "com.example.app",
    "channel": "beta"
  }' \
  https://api.capgo.app/channel/

Respuesta de éxito

{
  "status": "ok"
}

Limpieza de vista previa de la aplicación

Con delete_bundle: true, un app_preview clave puede limpiar de manera atómica solo un canal que creó y su paquete vinculado, no compartido. La clave no recibe permiso general. bundle.delete Ventana de terminal

curl -X DELETE \
  -H "capgkey: $CAPGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "com.example.app",
    "channel": "pr-123",
    "delete_bundle": true
  }' \
  https://api.capgo.app/channel/

Sección titulada “Gestión de errores”

Copiar a portapapeles

// Channel not found
{
  "error": "Channel not found",
  "status": "KO"
}

// Invalid bundle (version) format
{
  "error": "Invalid version format. Use semantic versioning",
  "status": "KO"
}

// Invalid update policy
{
  "error": "Invalid disableAutoUpdate value",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage channels",
  "status": "KO"
}

Uso común

Pruebas de beta

{
  "app_id": "com.example.app",
  "channel": "beta",
  "version": "1.2.0-beta",
  "public": false,
  "allow_emulator": true,
  "allow_dev": true
}

Despliegue en producción

{
  "app_id": "com.example.app",
  "channel": "production",
  "version": "1.2.0",
  "public": true,
  "disableAutoUpdate": "minor"
}

Actualizaciones específicas de plataforma

{
  "app_id": "com.example.app",
  "channel": "ios-hotfix",
  "version": "1.2.1",
  "ios": true,
  "android": false
}

Sigue adelante desde Canales

Si estás utilizando Canales Sigue adelante con la planificación de la ruta de canal y el despliegue en etapas, conectándolo con Canales para los detalles de implementación en Canales Canales para los detalles de implementación en Canales Solución de Pruebas Beta para el flujo de trabajo del producto en Solución de Pruebas Beta Solución de Enfoque de Versión para el flujo de trabajo del producto en Solución de Enfoque de Versión, y Capgo Mejores Prácticas del Entorno: Etapa con un ID de Aplicación Móvil para el contexto práctico en Capgo Mejores Prácticas del Entorno: Etapa con un ID de Aplicación Móvil