Canaux

Les canaux constituent le mécanisme de base pour gérer les mises à jour de l'application dans Capgo. Ils vous permettent de contrôler comment et quand vos utilisateurs reçoivent les mises à jour, ce qui permet des fonctionnalités comme les tests A/B, les lancements étalés et les mises à jour spécifiques au plateau.

Comprendre les canaux

Un canal représente une piste de distribution pour les mises à jour de votre application. Chaque canal peut être configuré avec des règles et des contraintes spécifiques :

• Gestion de l'emballage (version): Spécifiez quel emballage (version) les utilisateurs reçoivent
• Ciblage de plateforme: Ciblez des plateformes spécifiques (iOS/Android/Electron)
• Politiques de mise à jour: Contrôle comment les mises à jour sont livrées
• Restrictions de dispositif: Gérer lesquels appareils peuvent accéder aux mises à jour

Options de configuration de canal

• public: Définir comme canal par défaut pour les nouveaux appareils.
• disableAutoUpdateUnderNative: Empêcher les mises à jour lorsque la version native de l’application du dispositif est plus récente que la version stable du canal.
• disableAutoUpdate: Contrôler le comportement de mise à jour (major, minor, metadata, patch, ou none).
• ios/android/electron: Activer ou désactiver la livraison par plateforme.
• : Laisser les appareils choisir leur canal.: Autoriser les émulateurs.
• : Autoriser les appareils., : Autoriser les builds de développement., : Contrôler les appareils et les types de build qui reçoivent les mises à jour., Déroulement progressif: Maintenir un bundle stable tout en exposant un bundle cible à un groupe adhérent.
• VoirDéroulements progressifs Déroulement progressif.

Meilleures Pratiques

1. Canal de Test: Maintenez un canal de test pour la validation interne
2. Déploiement Graduel: Utilisez plusieurs canaux pour un déploiement d'actualisation graduel
3. Séparation de Plateforme: Créez des canaux séparés pour iOS, Android et Electron lorsque nécessaire
4. Gestion de Bundle (version): Utilisez la « gestion de version semantique » pour des chemins d'actualisation clairs pour des chemins d'actualisation clairs __CAPGO_KEEP_0__

Endpoints

POST

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

Créer ou mettre à jour une configuration de canal.

Corps de la demande

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
}

Pour les champs de rollout et d'auto-pause, la valeur API accepte également la forme équivalente snake_case ou rollout_version . Si les deux formes sont fournies, la valeur camelCase l'emporte. auto_pause_enabled__CAPGO_KEEP_0__ rollback seuls les camelCase.

Un cible de déploiement nécessite un canal existant. Il doit avoir un bundle stable déjà affecté ou en recevoir un à travers version en même requête POST. rollback et promoteToStable sont des actions terminales ; ne les combinez pas entre elles.

Exemple de requête

Configurer un déploiement de 5 % pour un canal existant dont le bundle stable est déjà défini : production Fenêtre 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/

__CAPGO_KEEP_0__

{
  "status": "ok"
}

La méthode POST est une mise à jour et ne retourne que son statut. Effectuez une requête GET pour lire la configuration du canal résultant.

Limite de clé de prévisualisation de l'application

Pour une prévisualisation de PR avec les privilèges les moins élevés, authentifiez cet endpoint avec authorization: $CAPGO_API_KEY ou capgkey: $CAPGO_API_KEY. Le x-api-key en-tête n'est pas accepté par les canaux API.

Une app_preview clé peut créer un nouveau canal de prévisualisation non public. La création donne automatiquement à cette clé une liaison de cycle de vie définie sur le canal uniquement. Le rôle ne comprend pas channel.update_settings, il ne peut donc pas utiliser la méthode POST pour mettre à jour un canal existant, y compris un canal par défaut ou principal existant.

Quitter public ou définissez-le sur false) pour les canaux de prévisualisation PR. Utilisez bundle upload --channel pour le flux de création et d'upload au lieu de traiter POST comme une mise à jour générale du canal de prévisualisation.

GET

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

Récupérer les informations du canal. Renvoie 50 canaux par page. Sans channel, la réponse est un tableau. Avec channel, la réponse est un objet de canal unique.

Paramètres de requête

• app_id: Obligatoire. L'ID de votre application
• page: Page optionnel. Numéro de page pour la pagination
• channel: Nom de canal spécifique à récupérer

Exemples de requêtes

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

Type de réponse

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 est un raccourci d'entrée uniquement et n'est pas retourné. Une mise en production arrêtée est représentée par une valeur non nulle rolloutPausedAt.

Exemple de réponse

[
  {
    "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"
  }
]

SUPPRIMER

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

Supprimer un canal. Notez que cela affectera tous les appareils utilisant ce canal.

Corps de la demande

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

Exemple de demande

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/

Réponse de succès

{
  "status": "ok"
}

Nettoyage de l'aperçu de l'application

Avec delete_bundle: true, un app_preview une clé peut nettoyer de manière atomique uniquement le canal qu'elle a créé et son bundle lié, non partagé. La clé n'a pas la permission générale. bundle.delete Fenêtre 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/

Section intitulée « Gestion des erreurs »

Scénarios d'erreurs courants et leurs réponses :

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

Utilisations courantes

1. Test de version bêta

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

2. Déploiement en production

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

3. Mises à jour spécifiques au plateforme

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

Continuez depuis les canaux

Si vous utilisez Canaux pour planifier l'ordonnancement des canaux et la mise en production étalée, connectez-le avec Canaux pour les détails d'implémentation dans Canaux, Canaux pour les détails d'implémentation dans Canaux, Solution de test bêta pour le flux de travail du produit dans Solution de test bêta, Solution de ciblage de version pour le flux de travail du produit dans Solution de ciblage de version, et Capgo Pratiques de l'environnement : mise en scène avec un ID d'application mobile unique pour le contexte pratique dans Capgo Pratiques de l'environnement de production : Étapes de mise en scène avec un seul ID d'application mobile.