API

Avtorizatsiya

Har bir CRM API so‘rovi avtorizatsiya sarlavhalarini uzatadi. Qaysi sarlavhalar usul uchun kerakligi, uning sahifasidagi «Avtorizatsiya» bo‘limida ko‘rsatilgan.

Integratsiyalar Authorization sarlavhasida API-token orqali avtorizatsiya qilinadi. Kirish tokeni token-access API orqali tizimga kirishda beriladi va foydalanuvchi nomidan ishlaydigan ilovalar uchun mos keladi.

Sarlavhalar

api-token

Sarlavha: Authorization · Format: fs_api_* · Quyidagi usullarda qo'llaniladi: 365

API-token api_tokens bo‘limidan olinadi. Authorization sarlavhasi qiymati — Bearer <token>. Hamkor tokeni: agar token berishda tarmoq tanlansa, u faqat shu tarmoq bilan ishlaydi va chain sarlavhasi kerak emas. Agar tarmoq tanlanmasa, token akkauntdagi barcha tarmoqlarga kirish huquqiga ega, lekin faol tarmog‘i yo‘q. Har bir tarmoq talab qilinadigan so‘rovda chain sarlavhasi yuborilishi shart, aks holda 117 xatolik va field: chain qaytariladi. /chains endpointi akkaunt tarmoqlarini qaytaradi; /chains.switch token uchun mavjud emas (268 xatolik).

Misol

Authorization: Bearer fs_api_YOUR_TOKEN

language

Sarlavha: language · Quyidagi usullarda qo'llaniladi: 374

Javob tili — ISO 639-1 kodi, masalan, uz

Misol

language: uz

role

Sarlavha: role · Quyidagi usullarda qo'llaniladi: 374

Foydalanuvchi roli: partner yoki affiliate

Misol

role: partner

chain

Sarlavha: chain · Quyidagi usullarda qo'llaniladi: 0

So‘rov bajarilayotgan tarmoq. Faqat tarmoq tanlanmagan holda berilgan hamkor tokeni uchun majburiy; boshqa hollarda e’tiborga olinmaydi

Misol

chain: YOUR_TOKEN

Sarlavhalar to‘plami

Ushbu metod to‘plamlardan birini qabul qiladi. API-tokenli to‘plamlar integratsiyalar uchun mos keladi.

api-token + language + roleusullar: 365
language + roleusullar: 9

Kirish xatoliklari

Noto‘g‘ri, bloklangan yoki muddati o‘tgan token va kerakli sarlavhasiz so‘rov kod bilan xatolik qaytaradi. Kodlarning qiymatlari — «Xatoliklar» bo‘limida.

Xatoliklar →