Perangkat

Copy sebuah prompt pengaturan dengan langkah-langkah instalasi dan panduan markdown lengkap untuk plugin ini.

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

Metadata perangkat

Setiap catatan dapat mencakup ID perangkat, platform, versi pembaruan dan OS, bangunan asli, paket yang diinstal, keadaan produksi dan emulator, ID kustom, dan pengaturan saluran.

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

Endpoint

POST

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

Setel pengaturan override khusus perangkat ke sebuah saluran pribadi. Untuk memilih paket untuk perangkat, tentukan paket tersebut ke saluran; pengaturan paket perangkat secara langsung tidak didukung.

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/

Retriev metadata perangkat. Hasilnya dikurasi dengan menggunakan cursor ketika Anda melewatkan device_id.

Parameter kueri

app_id: ID Aplikasi Domain yang Diperlukan secara Balik, seperti com.example.app.
device_id: ID Perangkat Opsional. Ketika ada, responsnya adalah perangkat tunggal daripada daftar yang dipaginasi.
customIdMode: Boolean Opsional. Atur ke true untuk mengembalikan hanya perangkat dengan nilai custom_id.
cursor: Cursor Opsional dari respons daftar sebelumnya.
limit: Jumlah Perangkat Opsional per Halaman.

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

Hapus

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

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

Minta tubuh 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 bidang. Kode kesalahan umum termasuk:

invalid_app_id ketika app_id tidak merupakan identifikasi domain-reverse.
device_not_found untuk pencarian perangkat 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.

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

Teruskan dari Perangkat

Jika Anda menggunakan Perangkat untuk merencanakan routing saluran dan peluncuran tahap demi tahap, hubungkannya dengan Saluran untuk detail implementasi di Saluran, Saluran untuk detail implementasi di Saluran, Saluran untuk detail implementasi di Saluran, Solusi Uji Coba Beta untuk alur kerja produk di Solusi Uji Coba Beta, dan Solusi Target Versi untuk alur kerja produk di Solusi Target Versi