Autentifikatsiya
Kalitingizni har bir so'rovda api-key sarlavhasida yuboring:
api-key: bik_sizning_kalitingizButun sxema shundan iborat. OAuth oqimi ham, token almashinuvi ham, yangilash ham yo'q: sotuvchi bekor qilmaguncha kalitning o'zi hisob ma'lumoti bo'lib qoladi.
Kalitlar qayerdan keladi
Ularni sotuvchi o'z Bione kompaniya panelidan beradi. Siz o'zingiz yarata olmaysiz, Bione qo'llab-quvvatlash xizmati ham — kalit ma'lumotlari ochiladigan sotuvchiga tegishli.
Kalit berayotganda u quyidagilarni tanlaydi:
- qanday ruxsatlar berilishi — quyidagi jadvalga qarang;
- muddati bor-yo'qligi — muddat ixtiyoriy va berish paytida belgilanadi.
Ochiq matn faqat bir marta, berish payti ko'rsatiladi. Bione faqat argon2 xeshini saqlaydi, shuning uchun yo'qolgan kalitni tiklab bo'lmaydi va qaytadan berish kerak. Sotuvchidan uni e-pochtadan xavfsizroq yo'l bilan yuborishini so'rang.
Kalitni almashtirish
Joyida almashtirish yo'q. Kalitni yangilash uchun: sotuvchi ikkinchisini beradi, siz unga o'tasiz, keyin u birinchisini bekor qiladi. Oraliqda ikkalasi ham ishlaydi, ya'ni integratsiyangiz to'xtab qoladigan payt bo'lmaydi.
Bekor qilish keyingi so'rovdan boshlab kuchga kiradi.
Kalit nimaga yetadi
Kalit aynan bitta sotuvchining ma'lumotlarini ochadi. Buni kengaytiradigan parametr, sarlavha yoki yo'l yo'q — boshqa sotuvchining buyurtmasini id bo'yicha so'rash 404 qaytaradi, xuddi mavjud bo'lmagan id kabi.
Bitta ruxsat bu yerda nomidan ko'ra torroq ishlaydi. cashback:read — sotuvchi o'z xodimlariga beradigan ruxsatning aynan o'zi, u yerda cashback hisobotlari va harakatlar tarixini ham ochadi. Bu API esa faqat mijozning joriy balansini, mijoz yo'llarida beradi. Ledger yoki hisobot uchun alohida endpoint yo'q.
Ruxsatlar (scopes)
Kalitingiz quyidagi ruxsatlarning bir qismini olib yuradi. Ularni sotuvchi kalitni bergan paytda tanlaydi va istalgan vaqtda o‘zgartirishi mumkin. Kalitingizda yo‘q ruxsat talab qiladigan so‘rov 403 bilan rad etiladi, javobda esa qaysi ruxsat yetishmagani aytilmaydi.
| Ruxsat | Nimaga ruxsat beradi |
|---|---|
orders:read | Buyurtmalar, ulardagi mahsulotlar, qismlar va qaytarish tarixini ko'rish |
orders:write | Buyurtma yaratish, holatini o'zgartirish, to'langan deb belgilash va qismlarni qayta taqsimlash |
products:read | Katalog va mahsulotning soliq ma'lumotlarini ko'rish |
products:write | Mahsulot yaratish, tahrirlash va o'chirish |
customers:read | Mijozlar va ularning holatini ko'rish |
customers:write | Mijoz yaratish va tahrirlash |
cashback:read | Keshbek hamyonlari, hisobotlari va harakatlar tarixini ko'rish |
Ruxsatlar faqat o'zini beradi. Ierarxiya yo'q: products:write products:read ni anglatmaydi va hammasini qamrab oladigan ma'muriy ruxsat ham yo'q. Ikkalasi kerak bo'lsa, ikkalasini so'rang.
Ba'zi narsalar kalitga umuman berilmaydi — buyurtmani bekor qilish, pul qaytarish, cashback'ni qo'lda o'zgartirish, xodimlarni boshqarish yoki yangi kalit berish. Bular sotuvchining o'z panelidagi odam qaroridir va hech qanday integratsiyaga berilmaydi.
Kalitni xavfsiz saqlash
- Unga parol kabi munosabatda bo'ling: bu egasiga huquq beruvchi hisob ma'lumoti, uni ushlab turgan har kim — bu siz.
- Serverda saqlang. Mobil ilova yoki brauzer to'plamidagi kalit — e'lon qilingan kalit.
- Repozitoriyda emas, maxfiy ma'lumotlar menejerida saqlang.
- Sizib chiqdi deb o'ylasangiz, sotuvchidan bekor qilishni so'rang. Bu bir zumda bo'ladi va unga faqat yangisini berish xarajatini keltiradi.
So'rov limitlari
Limit IP manzil bo'yicha emas, sotuvchi bo'yicha. Integratsiyangizni bir nechta serverda ishlatish uni ko'paytirmaydi, boshqa integrator bilan bitta ofis tarmog'ida bo'lish esa kamaytirmaydi.
Limitdan oshsangiz 429 qaytadi. Kuting va qayta urinib ko'ring.