Sebuah JSON API publik Interface memungkinkan software bertukar data terstruktur lewat HTTP request dan response. API RESTful bertipe milik Capgo memberi tim CapacitorJS dan Electron kontrol programatik atas live updates, channels, bundles, dan pengiriman ke perangkat.
Table of Contents
Memahami Dasar-dasar JSON API Publik Capgo
Capgo bukan direktori data umum. Antarmuka API JSON publiknya menghubungkan sistem build Anda dengan layanan pengiriman cloud Capgo, sehingga otomasi rilis dapat menerbitkan dan mengarahkan bundle web yang ditandatangani tanpa menunggu review App Store atau Play. REST menggunakan metode HTTP yang familiar seperti GET, POST, PUT, PATCH, dan DELETE, dengan JSON yang umumnya menjadi format respons, seperti dijelaskan dalam panduan API REST dari Postman ini.
Untuk Capgo, JSON adalah bahasa bersama antara skrip otomasi, job CI/CD, klien TypeScript, dan platform pengiriman. Konsistensi ini membuat payload mudah dibaca di logs dan mudah divalidasi sebelum deployment dimulai.
Apa yang Dikendalikan Interface
Gunakan endpoint JSON publik API untuk mengelola sumber daya rilis operasional, termasuk:
- Bundle, aset web dan metadata yang membentuk update yang dapat di-deploy.
- Channel, seperti staging, beta, production, atau stream rilis khusus pelanggan.
- Versi, yang mengidentifikasi dan melacak build yang ditugaskan ke channel tersebut.
- Targeting perangkat, yang membantu mengarahkan rilis ke platform, versi aplikasi, sistem operasi, atau grup metadata tertentu.
- Data observability, termasuk adopsi, kegagalan, aktivitas rollback, dan status per perangkat.
Request biasanya mengikuti urutan yang dapat diprediksi. Pipeline Anda membuat atau menyiapkan bundle, mengirim metadata JSON ke Capgo, memeriksa status yang dikembalikan, lalu menetapkan rilis ke channel yang sesuai. Query berikutnya dapat mengonfirmasi perangkat mana yang menerima update tersebut.
Ide utamanya: Anggap JSON Capgo sebagai kontrak kontrol rilis, bukan sekadar format data. Setiap field harus mendukung proses publishing, targeting, monitoring, atau pemulihan update aplikasi.
Mengapa typed JSON membantu
Payload bertipe mengurangi ambiguitas dalam codebase TypeScript. Identifier versi harus tetap string, flag rollout harus tetap Boolean, dan jumlah perangkat harus tetap numerik. Sebelum menghubungkan otomasi, definisikan antarmuka untuk permintaan dan respons, lalu validasi field wajib dan nilai nullable.
Baca juga: Pelajari lebih lanjut tentang penggunaan TypeScript dengan API.
Jaga tiga kebiasaan ini di setiap integrasi:
- Periksa status code dan body respons secara bersamaan, karena keberhasilan HTTP saja mungkin tidak menggambarkan penyelesaian deployment.
- Simpan identifier yang dikembalikan, terutama ID bundle, versi, dan channel, untuk panggilan berikutnya.
- Log dengan aman, kecuali kunci API dan data perangkat sensitif.
Bagian referensi berikut menggunakan fondasi ini untuk menjelaskan autentikasi, payload upload, skema channel, query targeting, dan objek error. Untuk nama endpoint dan definisi field terkini, verifikasi dokumentasi Capgo di capgo.app.
{\n“authorization”: “Bearer YOUR_CAPGO_API_KEY”,\n“contentType”: “application/json”,\n“accept”: “application/json”\n}
{ “success”: true, “bundleId”: “com.example.field-app”, “version”: “2.4.0”, “status”: “uploaded”, “bundleUuid”: “generated-bundle-identifier”, “createdAt”: “2026-01-15T10:30:00Z” }
{\n“defaultVersion”: “2.4.3”,\n“autoUpdate”: true,\n“rollbackProtection”: {\n“enabled”: true,\n“fallbackVersion”: “2.4.2”\n}\n}
{ “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 } }
{ “error”: { “code”: “INVALID_PARAMETER”, “message”: “Field ‘version’ wajib diisi”, “field”: “version”, “details”: { “expected”: “string”, “received”: “null” } } }
{\n“version”: “2.4.0”,\n“checksum”: “sha256-value”,\n“encryption”: true,\n“externalUrl”: “https://storage.example/bundle.zip}” }
