Ikhtisar API

Ini adalah dokumentasi API publik Capgo cloud. API memungkinkan Anda untuk mengelola sumber daya Capgo secara programatis, termasuk organisasi, perangkat, saluran, dan bundle. Ini dirancang untuk menjadi RESTful dan menggunakan metode HTTP standar.

Autentikasi

Semua endpoint API memerlukan autentikasi. Untuk mengautentikasi permintaan Anda, tambahkan kunci API Anda di header authorization.

Contoh:

curl -H "authorization: your-api-key" https://api.capgo.app/organization/

Dapatkan kunci API Hasilkan kunci API Anda di dasbor Capgo

Pembatasan Kecepatan

API menerapkan pembatasan kecepatan untuk memastikan penggunaan yang adil. Batas saat ini adalah:

• 100 permintaan per menit untuk akun standar
• 1000 permintaan per menit untuk akun perusahaan

Jika Anda melebihi batas ini, Anda akan menerima respons 429 (Too Many Requests).

Format Respons

Semua respons dalam format JSON. Respons yang berhasil biasanya mencakup objek data atau bidang status. Respons kesalahan mencakup bidang error dengan deskripsi tentang apa yang salah.

Contoh respons berhasil:

{
  "status": "ok",
  "data": { ... }
}

Contoh respons kesalahan:

{
  "error": "Invalid API key",
  "status": "KO"
}

Endpoint yang Tersedia

Organisasi Buat dan kelola organisasi, perbarui pengaturan, dan tangani konfigurasi tingkat organisasi

Kunci API Hasilkan, daftarkan, dan cabut kunci API untuk akses aman ke API Capgo

Anggota Kelola anggota organisasi, peran, dan izin

Statistik Akses analitik terperinci tentang penggunaan aplikasi, penyimpanan, dan konsumsi bandwidth

Saluran Kontrol saluran pembaruan aplikasi, versi, dan kebijakan pembaruan

Perangkat Lacak dan kelola perangkat yang menjalankan aplikasi Anda, termasuk penugasan versi dan saluran

Bundle Tangani bundle aplikasi, termasuk mengunggah, mendaftarkan, dan mengelola versi

Praktik Terbaik

1. Penanganan Kesalahan: Selalu periksa respons kesalahan dan tangani dengan tepat
2. Pembatasan Kecepatan: Terapkan backoff eksponensial saat mencapai batas kecepatan
3. Caching: Cache respons bila sesuai untuk mengurangi panggilan API
4. Versi: Lacak perubahan API melalui changelog kami