API

Autorizare

Fiecare solicitare către CRM API transmite anteturile de autorizare. Ce anteturi sunt necesare pentru o anumită metodă, este indicat pe pagina acesteia în blocul „Autorizare”.

Integrările se autorizează printr-un token API în antetul Authorization. Tokenul de acces token-access este emis la autentificarea prin API și este potrivit pentru aplicațiile care funcționează în numele utilizatorului.

Titluri

api-token

Antet: Authorization · Format: fs_api_* · Folosit în metode: 365

Tokenul API din secțiunea api_tokens. Valoarea antetului Authorization este Bearer <token>. Tokenul partenerului: dacă la generarea tokenului a fost selectată o rețea, acesta funcționează doar cu acea rețea și antetul chain nu este necesar. Dacă nu a fost selectată nicio rețea, tokenul are acces la toate rețelele contului, dar nu are o rețea activă. Fiecare cerere care necesită o rețea trebuie să transmită antetul chain, altfel se returnează eroarea 117 cu field: chain. /chains returnează rețelele contului; /chains.switch nu este disponibil pentru token (eroare 268).

Exemplu

Authorization: Bearer fs_api_YOUR_TOKEN

language

Antet: language · Folosit în metode: 374

Limba răspunsului — cod ISO 639-1, de exemplu ru

Exemplu

language: ro

role

Antet: role · Folosit în metode: 374

Rolă utilizator: partner sau affiliate

Exemplu

role: partner

chain

Antet: chain · Folosit în metode: 0

Rețeaua în care este efectuată cererea. Obligatoriu doar pentru tokenul de partener emis fără selectarea rețelei; în celelalte cazuri este ignorat

Exemplu

chain: YOUR_TOKEN

Seturi de anteturi

Metoda acceptă unul dintre seturi. Seturile cu token API sunt potrivite pentru integrări.

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

Erori de acces

Un token incorect, blocat sau expirat și o cerere fără antetul necesar returnează o eroare cu un cod. Valorile codurilor se găsesc în secțiunea „Erori”.

Erori →