API

Авторизация

Әрбір CRM API сұранысы авторизация тақырыптарын жібереді. Қай тақырыптардың әдіске қажет екені оның бетінде «Авторизация» бөлімінде көрсетілген.

Интеграциялар API токені арқылы Authorization тақырыбында авторизацияланады. Қол жеткізу токені token-access API арқылы кіру кезінде беріледі және пайдаланушы атынан жұмыс істейтін қосымшаларға арналған.

Тақырыптар

api-token

Тақырып: Authorization · Пішімі: fs_api_* · Әдістерде қолданылады: 47

API-токен api_tokens бөлімінен алынады. Authorization тақырыбының мәні — Bearer <токен>. Серіктестік токен: егер токен беру кезінде желі таңдалса, ол тек осы желімен жұмыс істейді және chain тақырыбы қажет емес. Егер желі таңдалмаса, токен аккаунттағы барлық желілерге қол жеткізе алады, бірақ белсенді желі жоқ. Әрбір желі қажет сұраныста chain тақырыбы берілуі тиіс, әйтпесе 117 қатесі қайтарылады, field: chain. /chains аккаунт желілерін қайтарады; /chains.switch токенге қолжетімсіз (268 қатесі).

Мысал

Authorization: Bearer fs_api_YOUR_TOKEN

language

Тақырып: language · Әдістерде қолданылады: 56

Жауап тілі — ISO 639-1 коды, мысалы, ru

Мысал

language: kk

role

Тақырып: role · Әдістерде қолданылады: 56

Пайдаланушы рөлі: partner немесе affiliate

Мысал

role: affiliate

chain

Тақырып: chain · Әдістерде қолданылады: 0

Сұраныс орындалатын желі. Тек желі таңдалмаған серіктестік токен үшін міндетті; басқа жағдайларда еленбейді

Мысал

chain: YOUR_TOKEN

Тақырыптар жиынтығы

Әдіс жиынтықтардың бірін қабылдайды. API-токені бар жиынтықтар интеграцияларға жарамды.

api-token + language + roleәдістер: 47
language + roleәдістер: 9

Қол жеткізу қателері

Жарамсыз, бұғатталған немесе мерзімі өткен токен және қажетті тақырыпсыз сұраныс қате кодымен қайтарылады. Кодтардың мәндері — «Қателер» бөлімінде.

Қателер →