Autoryzacja

Każde żądanie do CRM API przekazuje nagłówki autoryzacyjne. Jakie nagłówki są wymagane przez daną metodę, jest wskazane na jej stronie w sekcji „Autoryzacja”.

Integracje autoryzują się za pomocą tokena API w nagłówku Authorization. Token dostępu token-access jest wydawany podczas logowania przez API i jest odpowiedni dla aplikacji działających w imieniu użytkownika.

Nagłówki

`api-token`

Nagłówek: Authorization · Format: fs_api_* · Używane w metodach: 47

Token API z sekcji api_tokens. Wartość nagłówka Authorization — Bearer <token>. Token partnera: jeśli podczas wydawania tokena wybrano sieć, działa on tylko z tą siecią i nagłówek chain nie jest wymagany. Jeśli sieć nie została wybrana, token ma dostęp do wszystkich sieci konta, ale nie ma aktywnej sieci. Każde żądanie wymagające sieci musi przekazywać nagłówek chain, w przeciwnym razie zwracany jest błąd 117 z field: chain. /chains zwraca sieci konta; /chains.switch jest niedostępny dla tokena (błąd 268).

Przykład

Authorization: Bearer fs_api_YOUR_TOKEN

`language`

Nagłówek: language · Używane w metodach: 56

Język odpowiedzi — kod ISO 639-1, na przykład ru

Przykład

language: pl

`role`

Nagłówek: role · Używane w metodach: 56

Rola użytkownika: partner lub affiliate

Przykład

role: affiliate

`chain`

Nagłówek: chain · Używane w metodach: 0

Sieć, w której wykonywane jest żądanie. Wymagane tylko dla tokena partnera wydanego bez wyboru sieci; w pozostałych przypadkach ignorowane

Przykład

chain: YOUR_TOKEN

Zestawy nagłówków

Metoda przyjmuje jeden z zestawów. Zestawy z tokenem API nadają się do integracji.

`api-token` + `language` + `role`	metodów: 47
`language` + `role`	metodów: 9

Błędy dostępu

Nieprawidłowy, zablokowany lub wygasły token oraz żądanie bez wymaganego nagłówka zwracają błąd z kodem. Wartości kodów znajdują się w sekcji „Błędy”.

Błędy →