A publik API JSON Interface publik Capgo JSON memungkinkan perangkat lunak berbagi data terstruktur melalui permintaan dan respons HTTP. Capgo’s tipe, RESTful API memberikan tim CapacitorJS dan Electron kontrol programatis atas update hidup, saluran, paket, dan pengiriman perangkat.
Isi Kandungan
Mengerti Dasar-Dasar Capgo JSON Publik API
Capgo isn’t a general-purpose data directory. Its public API JSON interface connects your build system with Capgo’s cloud delivery service, so release automation can publish and direct signed web bundles without waiting for App Store or Play review. REST uses familiar HTTP methods such as GET, POST, PUT, PATCH, dan DELETEdengan JSON seringkali berfungsi sebagai format respons, seperti yang dijelaskan di sini Petunjuk API REST dari Postman.
Untuk Capgo, JSON adalah bahasa yang sama digunakan oleh skrip otomatisasi, pekerjaan CI/CD, klien TypeScript, dan platform pengiriman. Konsistensi ini membuat payload dapat dibaca dalam log dan mudah diverifikasi sebelum proses pengiriman dimulai.
Apa yang dikontrol oleh Interface
Pakai endpoint JSON publik API untuk mengelola sumber daya rilis operasional, termasuk:
- Paket, aset web dan metadata yang membentuk update yang dapat dijalankan.
- Saluran, seperti tahap pengujian, beta, produksi, atau aliran rilis khusus pelanggan.
- Versi, yang mengidentifikasi dan mengikuti pembangunan yang diberikan kepada saluran-saluran tersebut.
- Pengaturan perangkatyang membantu mengarahkan rilis ke platform, versi aplikasi, sistem operasi, atau kelompok metadata tertentu.
- Data ObservabilityTermasuk adopsi, kegagalan, aktivitas rollback, dan status per-perangkat.
Sebuah permintaan biasanya mengikuti urutan yang dapat diprediksi. Pipa Anda menciptakan atau mempersiapkan sebuah bundle, mengirim metadata JSON ke Capgo, memeriksa status yang dikembalikan, dan kemudian menugaskan rilis ke saluran yang tepat. Pertanyaan yang lebih lanjut dapat mengonfirmasi perangkat mana yang menerima update.
Kunci ide: Tangani JSON Capgo sebagai kontrak pengendalian rilis, bukan hanya sebagai format data. Setiap bidang harus mendukung publikasi, target, pemantauan, atau pemulihan update aplikasi.
Mengapa JSON Tipe Bantu
Pengiriman tipe yang ditekan mengurangi ketidakjelasan dalam kodebase TypeScript. Identifikasi versi harus tetap string, flag peluncuran harus tetap Boolean, dan hitungan perangkat harus tetap numerik. Sebelum menghubungkan otomatisasi, definisikan interface untuk permintaan dan respons, lalu validasi bidang yang diperlukan dan nilai yang dapat diabaikan.
Baca juga: Pelajari lebih lanjut tentang menggunakan TypeScript dengan API.
Jaga tiga kebiasaan dalam setiap integrasi:
- Periksa kode status dan tubuh respons bersama-samaKarena kesuksesan HTTP sendiri mungkin tidak menjelaskan penyelesaian penginstalan.
- Simpan identifikasi yang dikembalikan.Terutama ID bundle, versi, dan saluran, untuk panggilan berikutnya.
- Log dengan aman.Mengabaikan kunci API dan data perangkat sensitif.
Referensi bagian berikut menggunakan dasar ini untuk menjelaskan autentikasi, muatan unggahan, skema saluran, kueri target, dan objek kesalahan. Untuk nama endpoint saat ini dan definisi bidang, verifikasi dokumentasi Capgo di capgo.app.
{ “otorisasi”: “Bearer YOUR_CAPGO_API_KUNCI”, “konten”: “application/json”, “terima”: “application/json” }
{ “sukses”: true, “bundleId”: “com.example.field-app”, “versi”: “2.4.0”, “status”: “diunggah”, “bundleUuid”: “identifikasi-bundle-dibuat”, “createdAt”: “2026-01-15T10:30:00Z” }
{ “versiDefault”: “2.4.3”, “autoUpdate”: true, “rollbackProtection”: { “dipungkiri”: true, “fallbackVersion”: “2.4.2” } }
{ “data”: [ { “timestamp”: “2026-02-04T09:00:00Z”, “installs”: 842, “rollbacks”: 3, “errors”: 11 }, { “timestamp”: “2026-02-04T10:00:00Z”, “installs”: 1276, “rollbacks”: 2, “errors”: 8 } ], “summary”: { “totalInstalls”: 2118, “totalRollbacks”: 5, “totalErrors”: 19 } }
{ “kesalahan”: { “code”: “INVALID_PARAMETER”, “pesan”: “Bidang ‘versi’ diperlukan”, “bidang”: “versi”, “detail”: { “diharapkan”: “string”, “diterima”: “null” } } }
{"targetLanguage":"Indonesian","text":"{\n“versi”: “2.4.0”,\n“checksum”: “sha256-value”,\n“enkripsi”: true,\n“urlEksternal”: “”}https://storage.contoh/bundle.zip” }
