Авторизация

Каждый запрос к CRM API передаёт заголовки авторизации. Какие заголовки нужны методу, указано на его странице в блоке «Авторизация».

Запросы авторизуются API-токеном в заголовке Authorization: Bearer <токен>. Токен выпускается в CRM, в разделе «API-токены».

Заголовки

`api-token`

Заголовок: Authorization · Формат: fs_api_* · Используется в методах: 365

API-токен из раздела api_tokens. Значение заголовка Authorization — Bearer <токен>. Токен партнёра: если при выдаче токена выбрана сеть, он работает только с этой сетью, и заголовок chain не нужен. Если сеть не выбрана, токен имеет доступ ко всем сетям аккаунта, но активной сети у него нет. Каждый запрос, которому нужна сеть, должен передавать заголовок chain, иначе возвращается ошибка 117 с field: chain. /chains возвращает сети аккаунта; /chains.switch токену недоступен (ошибка 268).

Пример

Authorization: Bearer fs_api_YOUR_TOKEN

`language`

Заголовок: language · Используется в методах: 374

Язык ответа — код ISO 639-1, например ru

Пример

language: ru

`role`

Заголовок: role · Используется в методах: 374

Роль пользователя: partner или affiliate

Пример

role: partner

`chain`

Заголовок: chain · Используется в методах: 0

Сеть, в которой выполняется запрос. Обязателен только для токена партнёра, выданного без выбора сети; в остальных случаях игнорируется

Пример

chain: YOUR_TOKEN

Наборы заголовков

Наборы заголовков, которые принимают методы. Набор метода указан на его странице в блоке «Авторизация».

`api-token` + `language` + `role`	методов: 365
`language` + `role`	методов: 9

Ошибки доступа

Неверный, заблокированный или просроченный токен и запрос без нужного заголовка возвращают ошибку с кодом. Значения кодов — в разделе «Ошибки».

Ошибки →