API Ringkasan

This is the documentation of the public API of Capgo cloud. The API allows you to programmatically manage your Capgo resources, including organizations, devices, channels, and bundles. It’s designed to be RESTful and uses standard HTTP methods.

Pengaturan

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 Pengaturan Batas

Pengaturan batas penggunaan

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

Pengaturan saluran perangkat

Pengaturan saluran perangkat menggunakan plugin API dan memiliki batasan pencegahan abusi yang berbeda yang berlaku untuk setiap rencana, 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.
• Mengatur 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 per-detik reset.
• Batasan tambahan 1000 permintaan saluran per menit berlaku untuk setiap aplikasi dan alamat IP.

Batasan ini bukan berlaku secara akun. retryAfterSeconds Jika switcher saluran Anda dapat kembali ke saluran yang baru-baru ini dipilih, tunggu selama

durasi dalam respons 429 sebelum mencoba lagi.

Judul “Format Respons” data Semua respons dalam format JSON. Respons sukses biasanya mencakup entri status atau field. error Respons kesalahan mencakup field

dengan deskripsi apa yang salah.

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

Salin ke clipboard (Copy to clipboard) tidak diterjemahkan karena merupakan label navigasi yang tidak perlu diterjemahkan secara harfiah. Contoh respons 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 yang 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 Lacak dan kelola perangkat yang menjalankan aplikasi Anda, termasuk penugasan paket (versi) dan saluran

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

Praktik Terbaik

1. Pengolahan Kesalahan: Selalu periksa respons kesalahan dan tangani dengan tepat
2. Pengaturan Batas: Implementasikan backoff eksponensial ketika menabrak batas limit
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 alur autentikasi dan 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 (Perusahaan) untuk detail implementasi di SSO (Perusahaan).