API

Autorizace

Každý požadavek na CRM API předává autorizační hlavičky. Které hlavičky jsou pro metodu potřeba, je uvedeno na její stránce v sekci „Autorizace“.

Integrace se autorizují pomocí API tokenu v hlavičce Authorization. Přístupový token token-access je vydán při přihlášení přes API a je vhodný pro aplikace, které pracují jménem uživatele.

Záhlaví

api-token

Záhlaví: Authorization · Formát: fs_api_* · Používá se v metodách: 365

API token z části api_tokens. Hodnota hlavičky Authorization je Bearer <token>. Partnerský token: pokud byla při vydání tokenu vybrána síť, funguje pouze s touto sítí a hlavička chain není potřeba. Pokud síť nebyla vybrána, token má přístup ke všem sítím účtu, ale nemá aktivní síť. Každý požadavek, který vyžaduje síť, musí obsahovat hlavičku chain, jinak je vrácena chyba 117 s field: chain. /chains vrací sítě účtu; /chains.switch není pro token dostupný (chyba 268).

Příklad

Authorization: Bearer fs_api_YOUR_TOKEN

language

Záhlaví: language · Používá se v metodách: 374

Jazyk odpovědi — kód ISO 639-1, například ru

Příklad

language: cs

role

Záhlaví: role · Používá se v metodách: 374

Role uživatele: partner nebo affiliate

Příklad

role: partner

chain

Záhlaví: chain · Používá se v metodách: 0

Síť, ve které je požadavek prováděn. Povinné pouze pro partnerský token vydaný bez výběru sítě; v ostatních případech se ignoruje

Příklad

chain: YOUR_TOKEN

Sady hlaviček

Metoda přijímá jednu ze sad. Sady s API tokenem jsou vhodné pro integrace.

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

Chyby přístupu

Neplatný, zablokovaný nebo expirovaný token a požadavek bez potřebného záhlaví vrací chybu s kódem. Hodnoty kódů najdete v sekci „Chyby“.

Chyby →