Dispositivi

Gli dispositivi sono installazioni di app individuali che inviano dati di aggiornamento a Capgo. Utilizza questo API per recuperare quei dati o impostare e rimuovere un override di canale privato specifico per dispositivo.

Ritenzione dei dati

I dati dei dispositivi sono conservati per 90 giorni da l'ultima attività del dispositivo. Un dispositivo non deve installare un aggiornamento per apparire: le verifiche di aggiornamento e statistiche possono aggiornare i suoi metadati.

Metadati del dispositivo

Ogni record può includere l'ID del dispositivo, la piattaforma, le versioni dell'aggiornatore e del sistema operativo, la costruzione nativa, il pacchetto installato, lo stato di produzione e di emulazione, l'ID personalizzato e l'override del canale.

Quando disponibile, country_code è il paese più recente valido a due lettere ISO 3166-1 ricevuto da una richiesta code gestita da Cloudflare. Non è un valore di posizione GPS o fornito dall'app. Può essere null quando non disponibile; utilizzare un lookup singolo dispositivo quando ne hai bisogno questo campo.

Punti di accesso

POST

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

Imposta un sovrapposizione specifica per dispositivo a un canale privato . Per scegliere un bundle per un dispositivo, assegna quel bundle al canale; le sovrapposizioni di bundle per dispositivo non sono supportate.

Corpo della richiesta

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

Esempio di richiesta

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/

I canali pubblici non possono essere utilizzati come sovrapposizioni di dispositivo.

Risposta di successo

{
  "status": "ok"
}

GET

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

Recupera i metadati del dispositivo. I risultati sono paginati con il cursore quando omitti device_id.

Parametri di query

• app_id: ID di applicazione obbligatorio in formato di dominio inverso, ad esempio com.example.app.
• device_id: ID dispositivo facoltativo. Se presente, la risposta è un singolo dispositivo anziché una lista paginata.
• customIdMode: Booleano facoltativo. Impostalo true per restituire solo i dispositivi con un metadato non vuoto. custom_id.
• cursor: Cursor facoltativo dal precedente elenco di risposta.
• limit: Numero di dispositivi per pagina facoltativo.

Esempi di richiesta

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

Tipi di risposta

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 è popolato da un lookup specifico del dispositivo quando Capgo ha memorizzato un paese valido derivato da Cloudflare-derived code. Le richieste senza un paese valido non cancellano il valore valido precedente; le risposte elencate possono ritornare null per questo campo.

Esempio di risposta (elenco)

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

Risposta di esempio (singolo dispositivo)

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

ELIMINA

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

Eliminare l'override del canale di un dispositivo. Il dispositivo utilizzerà nuovamente la sua selezione di canale normale; questo endpoint non elimina il record di metadati del dispositivo.

Corpo della richiesta o parametri di query

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

Richiesta di esempio

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/

Risposta di successo

{
  "status": "ok"
}

Errori

Gli errori utilizzano uno stato di errore HTTP e un corpo JSON con error e message campi. I codici di errore comuni includono:

• invalid_app_id quando app_id non è un identificatore di dominio inverso.
• device_not_found per un dispositivo sconosciuto ricerca.
• channel_not_found quando il canale richiesto non esiste.
• public_channel_override quando si tenta di sovrascrivere un dispositivo a un canale pubblico.
• invalid_version_id quando si tenta di sovrascrivere un bundle diretto; utilizzare un canale invece.
• cannot_access_app o cannot_access_channel quando la chiave API non dispone della permessione richiesta.

Casi d'uso comuni

1. Spostare un dispositivo di test in un canale beta privato

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

2. Rimettere un dispositivo alla selezione di canale normale

   Utilizzare il DELETE endpoint con l'ID dell'app e del dispositivo.

Continua da Devices

Se stai utilizzando Devices per pianificare la routing dei canali e la distribuzione in fase di testing, connettilo con Channels per i dettagli di implementazione in Channels, Channels per i dettagli di implementazione in Channels, Channels per i dettagli di implementazione in Channels, Soluzione di Test Beta per il flusso di lavoro del prodotto in Soluzione di Test Beta, e Soluzione di Targeting della Versione per il flusso di lavoro del prodotto in Soluzione di Targeting della Versione.