Avtorizasiya

Hər bir CRM API sorğusu avtorizasiya başlıqlarını ötürür. Hansı başlıqların metod üçün lazım olduğu onun səhifəsində "Avtorizasiya" blokunda göstərilib.

İnteqrasiyalar Authorization başlığında API tokeni ilə avtorizasiya olunur. Giriş zamanı API vasitəsilə verilən giriş tokeni token-access istifadəçi adından işləyən tətbiqlər üçün uyğundur.

Başlıqlar

`api-token`

Başlıq: Authorization · Format: fs_api_* · Metodlarda istifadə olunur: 47

API-token api_tokens bölməsindən alınır. Authorization başlığının dəyəri — Bearer <token>. Partnyor tokeni: əgər token verilişində şəbəkə seçilibsə, o yalnız həmin şəbəkə ilə işləyir və chain başlığı tələb olunmur. Əgər şəbəkə seçilməyibsə, token hesabdakı bütün şəbəkələrə çıxış əldə edir, lakin aktiv şəbəkəsi olmur. Şəbəkə tələb edən hər bir sorğu chain başlığını ötürməlidir, əks halda 117 səhvi və field: chain qaytarılır. /chains hesabın şəbəkələrini qaytarır; /chains.switch token üçün əlçatan deyil (səhv 268).

Nümunə

Authorization: Bearer fs_api_YOUR_TOKEN

`language`

Başlıq: language · Metodlarda istifadə olunur: 56

Cavab dili — ISO 639-1 kodu, məsələn, ru

Nümunə

language: az

`role`

Başlıq: role · Metodlarda istifadə olunur: 56

İstifadəçi rolu: partner və ya affiliate

Nümunə

role: affiliate

`chain`

Başlıq: chain · Metodlarda istifadə olunur: 0

Sorğu yerinə yetirilən şəbəkə. Yalnız şəbəkə seçilmədən verilmiş tərəfdaş tokeni üçün məcburidir; digər hallarda nəzərə alınmır

Nümunə

chain: YOUR_TOKEN

Başlıq dəstləri

Metod dəstlərdən birini qəbul edir. API-token ilə olan dəstlər inteqrasiyalar üçün uyğundur.

`api-token` + `language` + `role`	metodlar: 47
`language` + `role`	metodlar: 9

Giriş xətaları

Yanlış, bloklanmış və ya müddəti bitmiş token və lazımi başlıq olmadan göndərilən sorğu kodla səhv qaytarır. Kodların mənaları «Səhvlər» bölməsində göstərilmişdir.

Səhvlər →