Autentikasi dan scope
Buat kunci API, tentukan apa yang boleh dilakukan tiap kunci, kirim di setiap permintaan, dan tetap di dalam batas laju.
Setiap permintaan ke /v1 memerlukan kunci API. Kunci milik satu bisnis, tidak kedaluwarsa sendiri, dan bisa dicabut kapan saja.
Buat kunci
- Buka Pengaturan → Pengembang di Portal. Hanya pemilik yang dapat mengelola kunci.
- Pilih Buat kunci, ketik nama yang menunjukkan tempat kunci dipakai, lalu pilih akses untuk tiap sumber daya.
- Salin kunci sekarang. Bakasir hanya menyimpan hash, sehingga kunci tidak bisa ditampilkan lagi. Jika hilang, cabut lalu buat kunci baru.
Satu bisnis dapat memegang hingga 20 kunci aktif. Pakai satu kunci per integrasi agar satu kunci bisa dicabut tanpa mengganggu yang lain.
Kirim kunci
Kirim kunci sebagai bearer token:
curl https://api.bakasir.com/v1/me \
-H "Authorization: Bearer bak_kunci_anda"Header X-API-Key: bak_kunci_anda juga bisa dipakai. Selalu panggil API dari server Anda. Jangan menaruh kunci di halaman web atau aplikasi seluler.
Scope
Setiap kunci punya tingkat akses per sumber daya: tanpa akses, baca, atau tulis. Tulis sudah mencakup baca.
| Sumber daya | Tingkat | Dipakai oleh |
|---|---|---|
products | baca, tulis | /v1/products |
categories | baca, tulis | /v1/categories |
stock | baca, tulis | /v1/stock, /v1/stores |
customers | baca, tulis | /v1/customers |
sales | baca | /v1/sales |
orders | baca | /v1/orders |
Permintaan di luar akses kunci gagal dengan 403 dan kode insufficient_scope.
Batas laju
Setiap kunci boleh membuat 120 permintaan per menit secara bawaan. Bakasir dapat menaikkan batas untuk bisnis Anda. Setiap respons membawa header berikut:
| Header | Arti |
|---|---|
X-RateLimit-Limit | Permintaan yang diizinkan per menit |
X-RateLimit-Remaining | Sisa permintaan di menit berjalan |
X-RateLimit-Reset | Waktu Unix saat penghitung diatur ulang |
Saat melewati batas Anda menerima 429 dengan kode rate_limited dan header Retry-After dalam detik. Tunggu selama itu, lalu lanjutkan.
Cabut kunci
Pilih Cabut di samping kunci pada Pengaturan → Pengembang dan tahan tombolnya. Kunci langsung berhenti berfungsi dan permintaan dengan kunci itu mengembalikan 401 dengan kode revoked_api_key. Mencabut tetap tersedia walau plugin berakhir.
Saat kunci ditolak
| Status | Kode | Alasan |
|---|---|---|
| 401 | invalid_api_key | Kunci tidak ada, formatnya salah, atau tidak dikenal |
| 401 | revoked_api_key | Kunci sudah dicabut |
| 403 | plugin_inactive | Plugin Public API tidak aktif untuk bisnis |
| 403 | tenant_inactive | Akun bisnis ditangguhkan |
| 403 | insufficient_scope | Kunci tidak punya akses ke sumber daya atau metode ini |
| 429 | rate_limited | Terlalu banyak permintaan |
Terakhir diperbarui