Pengantar API

Dokumentasi ini adalah publik API dari Capgo cloud. API memungkinkan Anda mengelola sumber daya Capgo secara programatis, termasuk organisasi, perangkat, saluran, dan paket. Ini dirancang untuk 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 di dashboard Capgo

The authorization header masih diterima untuk kunci legacy API tetapi x-api-key adalah header yang direkomendasikan untuk semua jenis kunci, termasuk kunci yang dihash dengan aman.

Keterbatasan Rate

API mengimplementasikan keterbatasan rate 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 abusi yang terpisah yang berlaku untuk setiap paket, termasuk uji coba:

• Perangkat dapat membuat hingga 5 permintaan per detik untuk setiap operasi saluran (set, get, delete, atau list). Batasan ini dikaitkan dengan aplikasi, perangkat, dan operasi.
• Menetapkan perangkat yang sama ke saluran yang sama lebih dari sekali dalam 60 detik akan mengembalikan respons 429. Mengganti ke saluran yang berbeda diizinkan setelah batasan per-detik reset.
• Mengingat batasan tambahan 1000 permintaan saluran per menit untuk setiap aplikasi dan alamat IP.

Tidak ada batasan yang berlaku untuk semua akun. Jika pengubah saluran Anda dapat kembali ke saluran yang dipilih sebelumnya, tunggu sampai retryAfterSeconds Waktu tunggu dalam respons 429 sebelum mencoba lagi.

Bagian berjudul “Format Respons”

Semua respons dalam format JSON. Respons sukses biasanya mencakup baik atau data Salin ke clipboard status error. Respon kesalahan termasuk sebuah error lapangan dengan deskripsi apa yang salah.

Salin ke clipboard

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

Kunci API Generasi, 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, paket (versi), dan kebijakan pembaruan

Peralatan Track dan kelola peralatan yang menjalankan aplikasi Anda, termasuk penugasan saluran dan paket (versi)

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

Praktik Terbaik

1. Pengelolaan KesalahanSelalu periksa respons kesalahan dan tangani dengan tepat
2. Pengaturan Batasan Kuota: Implementasi backoff eksponensial ketika mencapai batas kecepatan
3. Caching: Simpan respons cache ketika perlu untuk mengurangi API panggilan
4. Pengaturan Versi: Ikuti perubahan API melalui catatan perubahan kami

Teruskan dari API Panduan

Jika Anda menggunakan API Panduan untuk merencanakan autentikasi dan alur akun, hubungkannya dengan @capgo/capacitor-login-media-sosial untuk detail implementasi di @capgo/capacitor-login-media-sosial, @capgo/capacitor-kunci-akses untuk detail implementasi di @capgo/capacitor-passkey, @capgo/capacitor-native-biometric untuk detail implementasi di @capgo/capacitor-native-biometric, Autentikasi Dua Faktor untuk detail implementasi di Autentikasi Dua Faktor, dan Single Sign-On (Enterprise) untuk detail implementasi di SSO (Enterprise).