API Ringkasan

Ini adalah dokumentasi dari API publik Capgo awan. API ini 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 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 Buatlah kunci API Anda di dashboard Capgo

Header masih diterima untuk kunci __CAPGO_KEEP_0__ legacy, tetapi authorization header is still accepted for legacy API keys, but x-api-key adalah header yang direkomendasikan untuk semua jenis kunci, termasuk kunci yang dihash dengan aman.

Limitasi Penggunaan

API mengimplementasikan limitasi 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).

Pengubahan saluran perangkat

Pengubahan saluran perangkat menggunakan plugin API dan memiliki batasan pencegahan penyalahgunaan yang berbeda yang berlaku untuk setiap paket, termasuk uji coba:

• Sebuah perangkat dapat membuat hingga 5 permintaan per detik untuk setiap operasi saluran (set, get, delete, atau list. Batasan ini berlaku untuk aplikasi, perangkat, dan operasi.
• Pengaturan perangkat yang sama ke saluran yang sama lebih dari sekali dalam 60 detik akan mengembalikan respons 429. Mengganti ke saluran yang berbeda diperbolehkan setelah batasan perdetik reset.
• Batasan tambahan 1000 permintaan saluran per menit berlaku untuk setiap aplikasi dan alamat IP.

Batasan-batasan ini bukan berlaku secara akun. Jika pengganti saluran Anda dapat kembali ke saluran yang dipilih sebelumnya, tunggu durasi dalam respons 429 sebelum mencoba lagi. retryAfterSeconds Format Respons

Bahasa Judul “Format Respons”

Contoh respons sukses: data __CAPGO_KEEP_0__ status __CAPGO_KEEP_1__ error __CAPGO_KEEP_2__

__CAPGO_KEEP_3__

{
  "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 tingkat organisasi

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

Anggota Kelola anggota organisasi, peran, dan hak akses

Statistik Analisis detail tentang penggunaan aplikasi, penyimpanan, dan konsumsi bandwidth

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

Perangkat 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. Selalu periksa respons kesalahan dan tangani dengan tepatPengaturan Batas
2. Penggunaan yang BaikMengimplementasikan backoff eksponensial ketika menabrak batasan kecepatan
3. Penggunaan CacheMenggunakan Cache respons ketika sesuai untuk mengurangi API panggilan
4. Pengaturan VersiMengikuti 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-media sosial untuk detail implementasi di capgo/capacitor-login-media sosial, di @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey di @capgo/capacitor-native-biometric untuk detail implementasi di @capgo/capacitor-native-biometric Pengamanan Dua Faktor untuk detail implementasi di Pengamanan Dua Faktor, dan SSO (Perusahaan) untuk detail implementasi di SSO (Perusahaan).