API Ringkasan

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

Autentikasi

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

Contoh:

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

Dapatkan kunci API Buatlah kunci API Anda di dashboard Capgo

Pengaturan Batasan

Implementasi API melakukan batasan penggunaan untuk memastikan penggunaan yang adil. Batasan saat ini adalah:

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

Jika Anda melebihi batasan ini, Anda akan menerima respons 429 (Terlalu Banyak Permintaan)

Format Respons

Semua respons dalam format JSON. Respons sukses biasanya mencakup entitas data objek atau status field. Tanggapan kesalahan termasuklah error field dengan deskripsi apa yang salah.

Contoh tanggapan sukses:

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

Contoh tanggapan kesalahan:

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

Endpoint yang Tersedia

Organisasi Buat dan kelola organisasi, update pengaturan, dan tangani pengaturan tingkat organisasi

API Kunci Generate, daftar, dan batalkan API kunci untuk akses aman ke Capgo API

Anggota Kelola anggota organisasi, peran, dan izin

Statistik Akses analisis detail tentang penggunaan aplikasi, penyimpanan, dan konsumsi bandwidth

Saluran Kontrol saluran pembaruan aplikasi, paket (versi), dan kebijakan pembaruan

Perangkat Rekam dan kelola perangkat yang menjalankan aplikasi Anda, termasuk penugasan paket (versi) dan saluran

Paket Kelola paket aplikasi, termasuk mengunggah, menampilkan, dan mengelola paket (versi)

Praktik Terbaik

1. Pengelolaan Kesalahan: Selalu periksa respons kesalahan dan tangani dengan tepat
2. Pengaturan Batas: Implementasikan backoff eksponensial ketika menabrak batas limit
3. Penggunaan Cache: Cache respons ketika sesuai untuk mengurangi API panggilan
4. Versi: Pantau perubahan API melalui catatan perubahan kami