API Ringkasan

Ini adalah dokumentasi dari API publik Capgo cloud. API memungkinkan Anda mengelola sumber daya Capgo secara programatis, termasuk organisasi, perangkat, saluran, dan paket. 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 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 sendiri 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 respons dalam format JSON. Respons sukses biasanya mencakup baik data objek atau status laporan. Respons kesalahan mencakup laporan error dengan deskripsi apa yang salah.

Contoh respons sukses:

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

Contoh respons kesalahan:

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

Endpoint yang Tersedia

Organisasi Buat dan kelola organisasi, update pengaturan, dan atur konfigurasi organisasi

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

Anggota Kelola anggota organisasi, peran, dan izin

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

Salin ke clipboard Pengaturan saluran pembaruan aplikasi, paket (versi), dan kebijakan pembaruan

Perangkat Pantau dan kelola perangkat yang menjalankan aplikasi Anda, termasuk pengaturan 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
3. Pengaturan Cache: Simpan respons cache ketika perlu 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 native-biometric @capgo @capacitor detail implementasi di native-biometric @capgo @capacitor Autentikasi Dua Faktor detail implementasi di Autentikasi Dua Faktor, dan SSO (Perusahaan) detail implementasi di SSO (Perusahaan).