Geräte
Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.
Geräte sind einzelne App-Installationen, die Updater-Metadaten an Capgo melden. Nutzen Sie API, um diese Metadaten abzurufen oder einen gerätespezifischen Private-Channel-Override zu setzen und zu entfernen.
Geräte-Metadaten
Abschnitt mit dem Titel „Geräte-Metadaten“Jeder Datensatz kann die Geräte-ID, Plattform, Updater- und OS-Versionen, Native Build, installiertes Bundle, Production- und Emulator-Status, eine Custom ID und einen Channel-Override enthalten.
Falls verfügbar, country_code ist der aktuellste gültige zweistellige ISO-3166-1-Ländercode code, der über eine von Cloudflare verarbeitete Anfrage für das Gerät empfangen wurde. Dabei handelt es sich nicht um GPS oder einen von deiner App gelieferten Standortwert. Er kann null wenn nicht verfügbar; nutze eine Single-Device-Abfrage, wenn du dieses Feld benötigst.
Endpoints
Abschnitt mit dem Titel „Endpoints“https://api.capgo.app/device/
Gerätespezifisches Override auf ein privates Channel setzen. Um ein Bundle für ein Gerät auszuwählen, weise dieses Bundle dem Channel zu; direkte Bundle-Overrides pro Gerät werden nicht unterstützt. Das Override läuft 90 Tage nach dem letzten Write ab, es sei denn, du POSTest es erneut.
Anforderungstext
Abschnitt mit dem Titel „Request body“interface DeviceChannelOverride { app_id: string; // reverse-domain app ID, for example com.example.app device_id: string; channel: string; // existing non-public channel name}Beispiel-Request
Abschnitt mit dem Titel „Beispiel-Request“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/Öffentliche Channels können nicht als Device Overrides verwendet werden.
Erfolgreiche Response
Abschnitt mit dem Titel „Erfolgreiche Response“{ "status": "ok"}https://api.capgo.app/device/
Ruft Device-Metadaten ab. Die Ergebnisse werden per Cursor paginiert, wenn Sie device_id.
Query-Parameter
Abschnitt mit dem Titel „Query-Parameter“app_id: Erforderliche App-ID im umgekehrten Domain-Format, z. B.com.example.app.device_id: Optionale Geräte-ID. Wenn angegeben, enthält die Antwort ein einzelnes Gerät statt einer paginierten Liste.customIdMode: Optionaler boolescher Wert. Auftruesetzen, um nur Geräte mit einem nicht leerencustom_id.cursor: Optionaler Cursor aus der vorherigen Listenantwort.limit: Optionale Anzahl der Geräte pro Seite.
Beispielanfragen
Abschnitt mit dem Titel „Beispielanfragen“# Get the first pagecurl -H "authorization: your-api-key" \ "https://api.capgo.app/device/?app_id=com.example.app"
# Get one device, including its request-derived country when availablecurl -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 IDcurl -H "authorization: your-api-key" \ "https://api.capgo.app/device/?app_id=com.example.app&customIdMode=true"
# Get the next pagecurl -H "authorization: your-api-key" \ "https://api.capgo.app/device/?app_id=com.example.app&cursor=2024-01-01T00:00:00Z%7Cdevice_456"Antworttypen
Abschnitt mit dem Titel „Antworttypen“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 wird durch einen gerätespezifischen Lookup befüllt, wenn Capgo ein gültiges, von Cloudflare abgeleitetes Land code gespeichert hat. Anfragen ohne gültiges Land löschen den letzten gültigen Wert nicht; Listen-Responses können Folgendes zurückgeben: null für dieses Feld.
Beispiel-Response (Liste)
Abschnitt mit dem Titel „Beispiel-Response (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}Beispiel-Response (einzelnes Gerät)
Abschnitt mit dem Titel „Beispiel-Response (einzelnes Gerät)“{ "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"}https://api.capgo.app/device/
Entfernt den Channel-Override eines Geräts. Das Gerät nutzt dann wieder seine normale Channel-Auswahl; dieser Endpoint löscht nicht den zugehörigen Metadaten-Eintrag.
Request-Body oder Query-Parameter
Abschnitt mit dem Titel „Request-Body oder Query-Parameter“interface DeviceOverrideRemoval { app_id: string; device_id: string;}Beispiel-Request
Abschnitt mit dem Titel „Beispiel-Request“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/Erfolgreiche Response
Abschnitt mit dem Titel „Erfolgreiche Response“{ "status": "ok"}Fehler verwenden einen HTTP-Statuscode und einen JSON-Body mit error und message Feldern. Häufige Fehlercodes sind:
invalid_app_idwennapp_idist kein Reverse-Domain-Identifier.device_not_foundbei der Suche nach einem unbekannten Device.channel_not_foundwenn der angeforderte Channel nicht existiert.public_channel_overridebeim Versuch, ein Device per Override auf einen öffentlichen Channel zu setzen.invalid_version_idbeim Versuch eines direkten Bundle-Overrides; nutze stattdessen einen Channel.cannot_access_appodercannot_access_channelwenn dem API Key die erforderliche Berechtigung fehlt.
Häufige Anwendungsfälle
Abschnitt mit dem Titel „Häufige Anwendungsfälle“-
Ein Testgerät in einen privaten Beta-Kanal verschieben
{"app_id": "com.example.app","device_id": "device_456","channel": "beta"} -
Ein Gerät auf die normale Kanalauswahl zurücksetzen
Nutze das
DELETEEndpoint mit den App- und Geräte-IDs.
Weiter mit Devices
Abschnitt mit dem Titel „Weiter mit Geräten“Wenn du es nutzt Geräte um Channel-Routing und Staged Rollout zu planen, verbinde es mit Kanäle für die Implementierungsdetails in Channels, Kanäle für die Implementierungsdetails in Channels, Kanäle für die Implementierungsdetails in Channels, Beta-Testing-Lösung für den Produkt-Workflow in der Beta-Testing-Lösung, und Version-Targeting-Lösung für den Produkt-Workflow in der Version-Targeting-Lösung.