Dispositivi

Copia un prompt di configurazione con le istruzioni di installazione e la guida markdown completa per questo plugin.

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 sovrapposizione di canale privato per dispositivo.

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

Sovrapposizioni di canale: una sovrapposizione POST viene rimossa 90 giorni dopo l'ultima scrittura di sovrapposizione, anche se il dispositivo continua a inviare segnali. L'invio di segnali non resettare il cronometro. Per evitare la pulizia, impostare defaultChannel nel Capacitor config (resiste alla reinstallazione) o chiamare setChannel() dal dispositivo. Dal plugin 5.34.0 / 6.34.0 / 7.34.0 / 8.0.0 e successive versioni, setChannel() è locale e viene cancellato alla reinstallazione, quindi l'app deve chiamarlo nuovamente. I plugin più vecchi scrivono un sovrascrittura backend che resiste alla reinstallazione e viene eliminato da questa pulizia. Vedi Console e API sovrascritture scadono dopo 90 giorni.

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 bundle installato, lo stato di produzione e di emulazione, l'ID personalizzato e la sovrascrittura del canale.

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

Punti di accesso

POST

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

Impostare un sovrapposizione specifica per dispositivo su un canale privato Per scegliere un bundle per un dispositivo, assegna quel bundle al canale; le sovrapposizioni di bundle per dispositivo non sono supportate. La sovrapposizione scade dopo 90 giorni dall'ultima scrittura a meno che non la si invii nuovamente con un POST.

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 sovrascritture di dispositivo.

Risposta di successo

{
  "status": "ok"
}

GET

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

Recupera i metadati del dispositivo. I risultati sono paginati a cursor quando si omette device_id.

Parametri di query

app_id: ID di applicazione di dominio inverso richiesto, ad esempio com.example.app.
device_id: ID dispositivo facoltativo. Quando presente, la risposta è un singolo dispositivo piuttosto che una lista paginata.
customIdMode: Opzionale boolean. Impostato su true : Opzionale cursor dalla risposta precedente della lista. custom_id.
cursor: Opzionale numero di dispositivi per pagina.
limitRichieste di esempio

Sottosezione intitolata “Richieste di esempio”

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

Sottosezione intitolata “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 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 Ecco la descrizione 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
}

Esempio di risposta (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"
}

Cancella

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

Elimina l'override del canale di un dispositivo. Il dispositivo utilizzerà nuovamente la sua selezione di canale normale; questo endpoint non cancella 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 codici di errore comuni includono:

invalid_app_id quando app_id non è un identificatore di dominio inverso.
device_not_found per una ricerca di dispositivo sconosciuto.
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.

utilizzo comune

Spostare un dispositivo di test in un canale beta privato

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

Rimetti a dispositivo alla selezione del canale normale

Utilizza il DELETE endpoint con gli ID dell'app e del dispositivo.

Continua da dispositivi

Se stai utilizzando Dispositivi per pianificare la routing dei canali e la distribuzione in fase di test, connettilo con Canali per i dettagli di implementazione in Canali, Canali per i dettagli di implementazione nei canali, Canali Beta Testing Solution per i dettagli di implementazione nei canali, Soluzione di testing beta per il workflow del prodotto in Soluzione di testing beta, e Soluzione di targeting della versione