Appareils

Les appareils sont des installations d'applications individuelles qui transmettent des métadonnées de mise à jour à Capgo. Utilisez ce API pour récupérer ces métadonnées ou définir et supprimer un décalage de canal spécifique à l'appareil.

Deux politiques de 90 jours

Inventaire des appareils : les enregistrements des appareils sont conservés pendant 90 jours Un appareil ne doit pas installer une mise à jour pour être visible : les mises à jour et les vérifications de statistiques peuvent actualiser ses métadonnées depuis la dernière activité de l'appareil.

Décalsages de canal : un décalage POST est supprimé 90 jours après la dernière écriture de décalagemême si l'appareil continue de se connecter. La connexion ne réinitialise pas ce compteur. Pour éviter cette suppression, définissez defaultChannel in Capacitor config (survives reinstall) or call setChannel() à partir de l'application. Sur le plugin 5.34.0 / 6.34.0 / 7.34.0 / 8.0.0 et ultérieur, setChannel() est local et est supprimé lors de la réinstallation, il faut donc que l'application l'appelle à nouveau. Les anciens plugins écrivent un décalque backend qui survit à la réinstallation et est supprimé par cette mise à jour. Voir Console et les décalques API expirent après 90 jours.

Méta-données du dispositif

Chaque enregistrement peut inclure l'ID du dispositif, la plateforme, les versions de l'actualiseur et du système d'exploitation, la construction native, le bundle installé, l'état de production et d'émulateur, l'ID personnalisé et le décalque de canal.

Lorsqu'il est disponible, country_code est la dernière valeur valide de deux lettres du code ISO 3166-1 de pays code reçu à partir d'une requête Cloudflare-traitée pour le dispositif. Il ne s'agit pas de la position GPS ou d'une valeur de localisation fournie par votre application. Il peut être null Utilisez une recherche unique lorsque ce champ n'est pas disponible.

Endpoints

POST

https://api.capgo.app/device/

Définir un décalage spécifique au dispositif sur un canal privé. Pour choisir un ensemble de ressources pour un appareil, affectez cet ensemble au canal ; les décalages de ressources par appareil ne sont pas pris en charge. Le décalage expire 90 jours après la dernière écriture, à moins que vous ne le renvoyiez par POST.

Corps de la demande

interface DeviceChannelOverride {
  app_id: string; // reverse-domain app ID, for example com.example.app
  device_id: string;
  channel: string; // existing non-public channel name
}

Exemple de demande

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

Public channels cannot be used as device overrides.

Réponse de réussite

{
  "status": "ok"
}

context

https://api.capgo.app/device/

Récupérer les métadonnées du dispositif. Les résultats sont paginés par curseur lorsqu'on omet device_id.

Paramètres de requête

• app_idSection intitulée « Paramètres de requête » com.example.app.
• device_id: ID de l'appareil facultatif. Lorsqu'il est présent, la réponse est un appareil unique plutôt qu'une liste paginée.
• customIdMode: bool facultatif. Défini à true retourner uniquement les appareils avec un nom non vide custom_id.
• cursor: curseur optionnel provenant de la réponse précédente de la liste.
• limit: nombre optionnel d'appareils par page.

Exemples de requêtes

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

# Get one device, including its request-derived country when available
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&device_id=device_456"

# Get only devices with a custom ID
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&customIdMode=true"

# Get the next page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&cursor=2024-01-01T00:00:00Z%7Cdevice_456"

Types de réponse

interface DeviceListResponse {
  data: Device[];
  nextCursor?: string;
  hasMore: boolean;
}

interface Device {
  updated_at: string;
  device_id: string;
  custom_id: string;
  version?: number;
  version_name: string | null;
  channel?: string;
  app_id: string;
  platform: "ios" | "android" | "electron";
  plugin_version: string;
  os_version: string;
  version_build: string;
  is_prod: boolean;
  is_emulator: boolean;
  key_id: string | null;
  install_source: string | null;
  country_code: string | null;
}

country_code is populated by a device-specific lookup when Capgo has stored a valid Cloudflare-derived country code. Requests without a valid country do not clear the last valid value; list responses may return null pour ce champ.

Réponse d'exemple (liste)

{
  "data": [
    {
      "device_id": "device_456",
      "custom_id": "test-device-1",
      "version": 1,
      "version_name": "1.0.0",
      "app_id": "com.example.app",
      "platform": "ios",
      "plugin_version": "5.0.0",
      "os_version": "17.0",
      "version_build": "1",
      "is_prod": true,
      "is_emulator": false,
      "key_id": null,
      "install_source": null,
      "country_code": null,
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "2024-01-01T00:00:00Z|device_456",
  "hasMore": true
}

Réponse d'exemple (appareil unique)

{
  "device_id": "device_456",
  "custom_id": "test-device-1",
  "version": 1,
  "version_name": "1.0.0",
  "app_id": "com.example.app",
  "platform": "ios",
  "plugin_version": "5.0.0",
  "os_version": "17.0",
  "version_build": "1",
  "is_prod": true,
  "is_emulator": false,
  "key_id": "MIIB",
  "install_source": null,
  "country_code": "FR",
  "updated_at": "2024-01-01T00:00:00Z",
  "channel": "beta"
}

Supprimer

https://api.capgo.app/device/

Supprimer la surcharge de canal d'un appareil. L'appareil utilisera à nouveau sa sélection de canal normale ; cet endpoint ne supprime pas son enregistrement de métadonnées.

Corps de la requête ou paramètres de requête

interface DeviceOverrideRemoval {
  app_id: string;
  device_id: string;
}

Exemple de requête

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

Réponse de réussite

{
  "status": "ok"
}

Erreurs

Les erreurs utilisent un code d'état HTTP et un corps JSON avec error et message champs. Les codes d'erreur courants incluent :

• invalid_app_id lorsque app_id n'est pas un identifiant de domaine inversé.
• device_not_found pour un appareil inconnu.
• channel_not_found Lorsque le canal demandé n'existe pas.
• public_channel_override lorsqu'on tente de surcharger un appareil vers un canal public.
• invalid_version_id Utilisez un canal à la place d'une mise à jour directe.
• cannot_access_app ou cannot_access_channel Lorsque la clé API n'a pas la permission requise.

Utilisations courantes

1. Déplacer un appareil de test vers un canal bêta privé

   {
     "app_id": "com.example.app",
     "device_id": "device_456",
     "channel": "beta"
   }

2. Réinitialiser un appareil pour la sélection de canal normale

   Utilisez l' DELETE endpoint with the app and device IDs.

Continuez depuis les Appareils

Si vous utilisez Appareils to plan channel routing and staged rollout, connect it with Channels pour les détails d'implémentation dans les canaux, Channels pour les détails d'implémentation dans les 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, et Solution de ciblage de version pour le flux de travail du produit dans Solution de ciblage de version.