Perangkat

Dapat dicopy prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

Perangkat adalah instalasi aplikasi individu yang melaporkan metadata pembaruan ke Capgo. Gunakan API untuk mengambil metadata tersebut atau mengatur dan menghapus pengaturan saluran privat perangkat.

Daftar perangkat: rekaman perangkat disimpan selama 90 hari dari aktivitas perangkat terakhir. Perangkat tidak perlu menginstal pembaruan untuk muncul: pembaruan dan pemeriksaan statistik dapat memperbarui metadata.

Pengaturan saluran: pengaturan saluran POST dihapus 90 hari setelah tulisan terakhir pengaturanmeskipun perangkat masih melakukan pemeriksaan. Pemeriksaan tidak akan mengatur ulang jam tersebut. Untuk menghindari penghapusan itu, atur defaultChannel di Capacitor konfigurasi (tetap ada setelah reinstall) atau panggil setChannel() melalui aplikasi. Pada plugin 5.34.0 / 6.34.0 / 7.34.0 / 8.0.0 dan setelahnya, setChannel() adalah lokal dan dihapus setelah reinstall, sehingga aplikasi harus memanggilnya lagi. Plugin yang lebih tua menulis override backend yang tetap ada setelah reinstall dan dihapus oleh proses pembersihan ini. Lihat Console dan API override akan berakhir setelah 90 hari.

Metadata Perangkat

Setiap rekaman dapat mencakup ID perangkat, platform, pembaruan updater dan versi OS, bangunan asli, paket yang terpasang, status produksi dan emulator, ID kustom, dan pengaturan saluran override.

Ketika tersedia, country_code is the latest valid two-letter ISO 3166-1 country code received from a Cloudflare-handled request for the device. It is not GPS or a location value supplied by your app. It can be null ketika tidak tersedia; gunakan pencarian tunggal perangkat ketika Anda membutuhkan field ini.

Endpoint

POST

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

Setalah mengatur pengaturan khusus per perangkat ke pribadi saluran. Untuk memilih paket untuk perangkat, alokasikan paket tersebut ke saluran; pengaturan paket per perangkat langsung tidak didukung. Pengaturan ini akan berakhir 90 hari setelah tulisan terakhir kecuali Anda mengirimnya lagi.

Badan Permintaan

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

Contoh permintaan

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/

Saluran publik tidak dapat digunakan sebagai pengganti perangkat.

Respons sukses

{
  "status": "ok"
}

GET

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

Retrieve device metadata. Results are cursor-paginated when you omit device_id.

Parameter Pencarian

app_idBab berjudul “Parameter kueri” com.example.app.
device_idID Perangkat Opsional. Ketika ada, responsnya adalah perangkat tunggal daripada daftar yang dipaginasi.
customIdMode: Boolean opsional. Tetapkan ke true untuk mengembalikan hanya perangkat dengan tidak kosong custom_id.
cursor: Pencarian kursor opsional dari respons daftar sebelumnya.
limit: Jumlah perangkat per halaman opsional.

Contoh permintaan

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

Jenis Respon

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 Untuk bidang ini.

Contoh respons (daftar)

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

Contoh Respons (Perangkat tunggal)

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

DELETE

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

Menghapus pengaturan saluran override perangkat. Perangkat akan menggunakan pilihan saluran normalnya lagi; endpoint ini tidak menghapus catatan metadata perangkat.

Badan Permintaan atau Parameter Pertanyaan

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

Contoh permintaan

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/

Respons sukses

{
  "status": "ok"
}

Kesalahan

Kesalahan menggunakan status HTTP dan tubuh JSON dengan error dan message lapangan. Termasuk kode kesalahan umum:

invalid_app_id ketika app_id tidak merupakan identifikasi domain yang dibalik.
device_not_found untuk pencarian perangkat yang tidak diketahui.
channel_not_found ketika saluran yang diminta tidak ada.
public_channel_override ketika mencoba mengganti perangkat ke saluran publik.
invalid_version_id ketika mencoba mengganti bundle langsung; gunakan saluran sebaliknya.
cannot_access_app atau cannot_access_channel ketika kunci API tidak memiliki izin yang diperlukan.

Penggunaan umum

Pindahkan perangkat uji ke saluran beta pribadi

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

Reset perangkat ke pilihan saluran normal

Gunakan DELETE endpoint dengan ID aplikasi dan perangkat.

Judul bagian “Teruskan dari Perangkat”

Jika Anda menggunakan Devices untuk merencanakan routing saluran dan peluncuran tahap demi tahap, hubungkannya dengan Sumber Saluran untuk detail implementasi di Channel, Sumber Saluran untuk detail implementasi di Channel, Saluran untuk detail implementasi di Saluran, Pengujian Beta Solusi untuk alur produk di Pengujian Beta Solusi, dan Pengaturan Target Versi Solusi untuk alur produk di Pengaturan Target Versi Solusi.