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

Tidak ada endpoint API yang 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 Kepala masih diterima untuk kunci legacy API, tetapi x-api-key adalah kepala yang disarankan untuk semua jenis kunci, termasuk kunci hash yang aman.

Pengaturan Batas

The API implements rate limiting to ensure fair usage. Current limits are:

• 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 tanggapan dalam format JSON. Tanggapan sukses biasanya mencakup baik data atau field. Tanggapan kesalahan mencakup field status dengan deskripsi apa yang salah. error Contoh tanggapan sukses:

Salin ke clipboard

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

Salin ke clipboard

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

Bagian Judul “Endpoint yang Tersedia”

__CAPGO_KEEP_0__ Buat dan kelola organisasi, update pengaturan, dan tangani konfigurasi tingkat organisasi

API Kunci Menghasilkan, menampilkan, dan membatalkan API kunci untuk akses yang aman ke Capgo API

Anggota Kelola anggota organisasi, peran, dan izin

Statistik Akses analitis rinci tentang penggunaan aplikasi, penyimpanan, dan konsumsi bandwidth

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

Perangkat Tangani dan kelola perangkat yang menjalankan aplikasi Anda, termasuk pengaturan paket (versi) dan saluran

Paket Tangani bundle aplikasi, termasuk mengunggah, menampilkan, dan mengelola bundle (versi)

Praktik Terbaik

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

Teruskan dari API Ringkasan

Jika Anda menggunakan API Ringkasan untuk merencanakan autentikasi dan alur akun, hubungkannya dengan @capgo/capacitor-login-social untuk detail implementasi di @capgo/capacitor-login-social, @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).