API Ringkasan

Ini adalah dokumentasi dari API publik Capgo cloud. API memungkinkan Anda mengelola sumber daya Capgo Anda secara programatik, 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 x-api-key header.

Contoh:

curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

Dapatkan kunci API Buat kunci API Anda di dashboard Capgo

The authorization header is still accepted for legacy API keys, but x-api-key Pengaturan header yang disarankan untuk semua jenis kunci, termasuk kunci hash yang aman.

Pengaturan Batasan

Implementasi API mengatur batasan 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).

Pengaturan Format Respons

Semua respons dalam format JSON. Respons sukses biasanya mencakup entitas atau 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 konfigurasi tingkat organisasi

API Kunci Buat, 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 Ikuti 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 batasan
3. Penggunaan Cache: Cache respons ketika tepat untuk mengurangi API panggilan
4. Pengaturan Versi: Tidak lupa mengikuti perubahan API melalui catatan perubahan kami

Lanjutkan dari API Ringkasan

Jika Anda menggunakan API Ringkasan Untuk merencanakan autentikasi dan alur akun, hubungkannya dengan @capgo/capacitor-login-sosial Untuk detail implementasi di @capgo/capacitor-login-sosial, @capgo/capacitor-passkey Untuk detail implementasi di @capgo/capacitor-passkey, @capgo/capacitor-biometrik-native Untuk detail implementasi di @capgo/capacitor-biometrik-native, Autentikasi Dua Faktor Untuk detail implementasi di Autentikasi Dua Faktor, dan SSO (Enterprise) Untuk detail implementasi di SSO (Enterprise).