Perangkat

Aplikasi 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.

Polisi 90 hari:

Daftar perangkat: rekaman perangkat disimpan selama 90 hari sejak 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 pengecekan. Pengecekan tidak akan mengatur ulang jam tersebut. Untuk menghindari penghapusan, atur defaultChannel di konfigurasi Capacitor (tetap ada setelah reinstall) atau panggil setChannel() dari 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 penghapusan ini. Lihat Console dan API override akan berakhir setelah 90 hari.

Pengaturan perangkat

Setiap rekaman dapat mencakup ID perangkat, platform, updater dan versi OS, build asli, bundle yang terpasang, status produksi dan emulator, ID kustom, dan pengaturan saluran.

Ketika tersedia, country_code adalah kode negara dua huruf terbaru yang valid ISO 3166-1 code yang diterima dari permintaan Cloudflare-diproses untuk perangkat. Ini bukan GPS atau nilai lokasi yang disediakan oleh aplikasi Anda. Ini dapat null ketika tidak tersedia; gunakan pencarian tunggal perangkat ketika Anda membutuhkan field ini.

Endpoint

POST

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

Mengatur pengaturan khusus per perangkat ke sebuah pribadi salah satu saluran. Untuk memilih bundle untuk perangkat, assign bundle tersebut ke saluran; pengaturan bundle per perangkat langsung tidak didukung. Pengaturan ini akan berakhir 90 hari setelah tulisan terakhir kecuali Anda mengirimkan POST lagi.

Isi 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/

Retriev data perangkat. Hasilnya dikurasi dengan cara cursor-paginasi ketika Anda mengabaikan device_id.

Parameter kueri

• app_id: ID domain aplikasi yang harus diisi secara balik, seperti com.example.app.
• device_id: ID perangkat opsional. Ketika ada, responsnya adalah perangkat tunggal daripada daftar yang dikurasi.
• customIdMode: Boolean opsional. Atur ke true : Untuk mengembalikan hanya perangkat dengan nilai tidak kosong custom_id.
• cursor: Cursor 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 respons

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 diisi oleh pencarian spesifik perangkat ketika Capgo telah menyimpan nilai negara Cloudflare-dapat berdasarkan code yang valid. Permintaan tanpa negara yang valid tidak menghapus nilai yang valid terakhir; respons daftar mungkin mengembalikan 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"
}

HAPUS

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

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

Badan permintaan atau parameter kueri

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 kesalahan dan tubuh JSON dengan error dan message kode kesalahan umum termasuk:

• 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 menggantikan perangkat ke saluran publik.
• invalid_version_id ketika mencoba mengganti bundle langsung; gunakan saluran sebaliknya.
• cannot_access_app atau cannot_access_channel when the API key lacks the required permission.

ketika kunci __CAPGO_KEEP_0__ tidak memiliki izin yang diperlukan.

1. Kasus penggunaan umum

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

2. Reset perangkat ke pilihan saluran normal

   Pilih endpoint dengan ID aplikasi dan perangkat. DELETE Teruskan dari Perangkat

Bab berjudul “Teruskan dari Perangkat”

Perangkat untuk merencanakan routing saluran dan peluncuran rolut, hubungkannya dengan Saluran context":"Saluran Rilis Capgo. Halaman/area: Halaman Pemasaran Solusi Capgo. Peran: Label UI singkat atau item navigasi. Dilihat di: halaman solusi/white-label.astro. Kunci pesan `solutions_white_label_visual_cell2_value` (Nilai Sel Visual Putih Label Solusi). untuk detail implementasi di Saluran, Saluran untuk detail implementasi di Channel, Channel untuk detail implementasi di Channel, Solusi Uji Coba Beta untuk alur produk di Solusi Uji Coba Beta, dan Solusi Target Versi untuk alur produk di Solusi Target Versi.