A JSON publik API interface lets software exchange structured data through HTTP requests and responses. Capgo’s typed, RESTful API gives CapacitorJS and Electron teams programmatic control over live updates, channels, bundles, and device delivery.
Tabel Konten
Memahami Capgo Publik API JSON Dasar
Capgo bukanlah direktori data umum. Interface publik API JSONnya menghubungkan sistem pembangunan dengan layanan pengiriman cloud Capgo, sehingga otomatisasi rilis dapat menerbitkan dan mengarahkan bundle web yang ditandatangani tanpa harus menunggu tinjauan App Store atau Play. GET, POST, PUT, PATCH, dan DELETEdengan JSON seringkali berfungsi sebagai format respons, seperti yang dijelaskan di sini Petunjuk REST API dari Postman.
For Capgo, JSON is the shared language between automation scripts, CI/CD jobs, TypeScript clients, and the delivery platform. That consistency makes payloads readable in logs and straightforward to validate before a deployment starts.
Apa yang Mengontrol Interface
Gunakan endpoint JSON publik API untuk mengelola sumber daya rilis operasional, termasuk:
- BundlesAset web dan metadata yang membentuk update yang dapat diinstal.
- Channelsseperti tahap pengembangan, beta, produksi, atau aliran rilis khusus pelanggan.
- Versiyang mengidentifikasi dan mengikuti pembangunan yang dialokasikan ke saluran-saluran tersebut.
- Target perangkatyang membantu mengarahkan rilis ke platform-platform tertentu, versi aplikasi, sistem operasi, atau kelompok metadata.
- Data observabilitastermasuk pengadopsian, gagal, aktivitas rollback, dan status perangkat per device.
Sebuah permintaan biasanya mengikuti urutan yang dapat diprediksi. Pipa Anda menciptakan atau mempersiapkan sebuah bundle, mengirimkan metadata JSON ke Capgo, memeriksa status yang dikembalikan, dan kemudian menugaskan rilis ke saluran yang tepat. Pertanyaan yang lebih lanjut dapat mengkonfirmasi perangkat mana yang menerima update.
Kunci ideanya: Tentukan Capgo JSON sebagai kontrak pengendalian rilis, bukan hanya sebagai format data. Setiap bidang harus mendukung publikasi, target, pemantauan, atau pemulihan update aplikasi.
Mengapa JSON Tipe Bermanfaat
Payload tipe yang dikurangi mengurangi ketidakjelasan dalam kodebase TypeScript. Identifikasi versi harus tetap string, flag rilis harus tetap Boolean, dan hitungan perangkat harus tetap numerik. Sebelum menghubungkan otomatisasi, tentukan interface untuk permintaan dan respons, lalu validasi bidang yang diperlukan dan nilai yang dapat diabaikan.
Selain itu: Baca lebih lanjut tentang menggunakan TypeScript dengan API.
Teruskan tiga kebiasaan dalam setiap integrasi:
- Jaga tiga kebiasaan dalam setiap integrasi:Karena kesuksesan HTTP saja mungkin tidak menjelaskan selesainya proses penginstalan.
- Preserve identifikator yang dikembalikanTerutama ID bundle, versi, dan saluran untuk panggilan berikutnya.
- Log safely, kecuali API dan data perangkat sensitif.
The following reference sections use this foundation to explain authentication, upload payloads, channel schemas, targeting queries, and error objects. For current endpoint names and field definitions, verify Capgo’s documentation at capgo.aplikasi.
{ “autentikasi”: “Bearer YOUR_CAPGO_API_KUNCI”, “konten_tipe”: “application/json”, “terima”: “application/json” }
Sukses: true, Bundle ID: com.example.field-app, Versi: 2.4.0, Status: diunggah, Bundle UUID: identifier-bundle-dibuat, Dibuat pada: 2026-01-15T10:30:00Z
{ “versiDefault”: “2.4.3”, “aktifkanPerbaruiOtomee”: true, “proteksiPerbaruiBalik”: { “aktifkan”: true, “versiPengganti”: “2.4.2” } }
Data: [ { Waktu: 2026-02-04T09:00:00Z, Instalasi: 842, Rollback: 3, Error: 11 }, { Waktu: 2026-02-04T10:00:00Z, Instalasi: 1276, Rollback: 2, Error: 8 } ], Ringkasan: { Total Instalasi: 2118, Total Rollback: 5, Total Error: 19 } }
Error: { code: "INVALID_PARAMETER", Pesan: "Bidang ‘versi’ diperlukan", Bidang: "versi", Detail: { Diperlukan: "string", Diterima: "null" } } }
Versi: 2.4.0, Checksum: nilai sha256, Enkripsi: true, URL eksternal: "https://storage.contoh/bundle.zip” }
