__CAPGO_KEEP_0__ - Actualizaciones en vivo para aplicaciones __CAPGO_KEEP_1__
Capgo - Live Updates for Capacitor Apps Capgo

Canales

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, lanzamientos escalonados y actualizaciones específicas de plataforma.

Entendiendo los canales

Sección titulada “Entendiendo los canales”

Un canal representa un seguimiento 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): Especificar qué paquete (versión) reciben los usuarios
  • : Dirigir plataformas específicas (iOS/Android/Electron): Dirigir plataformas específicas (iOS/Android/Electron)
  • Actualización de políticasControla cómo se entregan las actualizaciones
  • Restricciones de dispositivoAdministra qué dispositivos pueden acceder a las actualizaciones

Opciones de configuración de canal

Sección titulada “Opciones de configuración de canal”
  • públicoEstablece como canal predeterminado para nuevos dispositivos.
  • evitarActualizacionesBajoAppNativa: Evita actualizaciones cuando la versión nativa del dispositivo es más nueva que el paquete estable del canal.
  • evitarActualizaciones: Controla el comportamiento de actualización (major, minor, metadata, patcho none).
  • ios/android/electron: Habilitar o deshabilitar la entrega por plataforma.
  • allow_device_self_set: Dejar que los dispositivos elijan su canal.
  • allow_emulator, allow_device, allow_dev, : Controlar qué tipos de dispositivos y compilaciones reciben actualizaciones.Despliegue progresivo
  • : Mantener una versión estable del paquete mientras se expone una versión objetivo a un grupo cohesivo. Consulteallow_prod Despliegue progresivo.

Prácticas recomendadas

Sección titulada “Prácticas recomendadas”
  1. Canal de pruebas: Mantenga un canal de pruebas para la validación interna
  2. Despliegue en etapas: Utilice múltiples canales para el despliegue gradual de actualizaciones
  3. Separación de plataforma: Cree canales separados para iOS, Android y Electron cuando sea necesario
  4. Control de paquete (versión): Utilice control de versiones semántico para rutas de actualización claras

Endpoints

Sección titulada “Endpoints”

POST

Sección titulada “POST”

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

Crear o actualizar una configuración de canal.

Cuerpo de la solicitud

Sección titulada “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
  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
}

Para campos de rollout y auto-pausar, API también acepta la equivalente snake_case forma, como rollout_version o auto_pause_enabled. Si se proporcionan ambos formatos, el valor camelCase gana. rollback es camelCase solo.

Un objetivo de lanzamiento requiere un canal existente. Debe tener un paquete estable asignado ya sea que lo reciba a través de version en la misma solicitud POST. rollback y promoteToStable son acciones terminales; no las combine con una de ellas.

Solicitud de ejemplo

Sección titulada “Solicitud de ejemplo”

Configura un lanzamiento del 5% para un canal existente production cuyo paquete estable ya está configurado:

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/

Respuesta de éxito

Sección titulada “Respuesta de éxito”
{
  "status": "ok"
}

POST es un upsert y devuelve solo su estado. Haga una solicitud GET para leer la configuración del canal resultante.

Límite de clave de vista previa de la aplicación

Sección titulada “Límite de clave de vista previa de la aplicación”

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

Una app_preview clave puede crear un nuevo 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_settingsno puede usar POST para actualizar un canal existente, incluido un canal predeterminado o principal.

Dejar public sin establecer (o establezca a false) para canales de vista previa de PR. Utilice bundle upload --channel para el flujo de creación y carga en lugar de tratar a POST como una vista previa de canal de actualización general.

GET

Título de la sección “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.

Parámetros de consulta

Título de la sección “Parámetros de consulta”
  • app_id: Obligatorio. El ID de tu aplicación
  • page: Opcional. Número de página para paginación
  • channel: Opcional. Nombre de canal específico para recuperar

Ejemplos de solicitudes

Sección titulada “Ejemplos de solicitudes”
Ventana de terminal
# 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

Sección titulada “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
  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 entrada solo y no se devuelve. Una implementación pausada se representa con un valor no nulo rolloutPausedAt.

Ejemplo de respuesta

Sección titulada “Respuesta de ejemplo”
[
  {
    "id": 1,
    "name": "production",
    "app_id": "com.example.app",
    "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"
  }
]

DELETE

Sección titulada “DELETE”

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

Sección titulada “Cuerpo de la solicitud”
interface Channel {
  channel: string
  app_id: string
  delete_bundle?: boolean // also delete the linked bundle
}

Solicitud de ejemplo

Ventana de terminal
Copiar a portapapeles
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

Sección titulada “Respuesta de éxito”
{
  "status": "ok"
}

Eliminación de vista previa de la aplicación

Sección titulada “Eliminación de vista previa de la aplicación”

Con delete_bundle: true, un app_preview La 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

Copiar a portapapeles
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/

Section titled “Error Handling”

Sección titulada “Gestión de Errores”

Escenarios de errores comunes y sus respuestas:

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

Sección titulada “Uso común”
  1. Pruebas de Béta
{
  "app_id": "com.example.app",
  "channel": "beta",
  "version": "1.2.0-beta",
  "public": false,
  "allow_emulator": true,
  "allow_dev": true
}
  1. Implementación en Producción
{
  "app_id": "com.example.app",
  "channel": "production",
  "version": "1.2.0",
  "public": true,
  "disableAutoUpdate": "minor"
}
  1. Actualizaciones específicas de plataforma
{
  "app_id": "com.example.app",
  "channel": "ios-hotfix",
  "version": "1.2.1",
  "ios": true,
  "android": false
}

Continuar desde Canales

Sección titulada “Sigue adelante desde Canales”

Si estás utilizando Canales para planificar la ruta de canales y el lanzamiento en etapas, conecta 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 Prácticas de Entorno de Capgo : Etapa con un ID de Aplicación Móvil para el contexto práctico en Prácticas de Entorno de Capgo : Etapa con un ID de Aplicación Móvil.