Yetkilendirme
CRM API'ye yapılan her istekte yetkilendirme başlıkları iletilir. Hangi başlıkların gerekli olduğu, ilgili metodun sayfasında "Yetkilendirme" bölümünde belirtilmiştir.
Entegrasyonlar, Authorization başlığında API belirteci ile yetkilendirilir. Erişim belirteci token-access, API üzerinden giriş yapıldığında verilir ve kullanıcı adına çalışan uygulamalar için uygundur.
Başlıklar
api-token
Başlık: Authorization · Biçim: fs_api_* · Şu yöntemlerde kullanılır: 365
API belirteci api_tokens bölümünden alınır. Authorization başlığının değeri Bearer <token> şeklindedir. Partner belirteci: Belirteç oluşturulurken bir zincir seçildiyse, belirteç yalnızca bu zincirle çalışır ve chain başlığı gerekmez. Zincir seçilmediyse, belirteç hesabın tüm zincirlerine erişebilir, ancak aktif zinciri yoktur. Zincir gerektiren her istekte chain başlığı iletilmelidir, aksi halde 117 hatası ve field: chain döner. /chains hesabın zincirlerini döndürür; /chains.switch belirteci için erişilemez (268 hatası).
Örnek
Authorization: Bearer fs_api_YOUR_TOKENlanguage
Başlık: language · Şu yöntemlerde kullanılır: 374
Yanıt dili — ISO 639-1 kodu, örneğin ru
Örnek
language: trrole
Başlık: role · Şu yöntemlerde kullanılır: 374
Kullanıcı rolü: partner veya affiliate
Örnek
role: partnerchain
Başlık: chain · Şu yöntemlerde kullanılır: 0
Sorgunun gerçekleştirildiği ağ. Yalnızca ağ seçilmeden verilen partner tokeni için zorunludur; diğer durumlarda yok sayılır
Örnek
chain: YOUR_TOKENBaşlık setleri
Yöntem, setlerden birini kabul eder. API anahtarı içeren setler entegrasyonlar için uygundur.
api-token + language + role | yöntemler: 365 |
language + role | yöntemler: 9 |
Erişim hataları
Geçersiz, engellenmiş veya süresi dolmuş bir token ile ya da gerekli başlık olmadan yapılan istekler, bir hata kodu ile yanıtlanır. Kodların anlamları «Hatalar» bölümünde yer almaktadır.
Hatalar →