Авторизація

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

Інтеграції авторизуються за допомогою API-токена в заголовку Authorization. Токен доступу token-access видається під час входу через 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, наприклад uk

Приклад

language: uk

`role`

Заголовок: role · Використовується в методах: 374

Роль користувача: partner або affiliate

Приклад

role: partner

`chain`

Заголовок: chain · Використовується в методах: 0

Мережа, в якій виконується запит. Обов’язковий лише для токена партнера, виданого без вибору мережі; в інших випадках ігнорується

Приклад

chain: YOUR_TOKEN

Набори заголовків

Метод приймає один із наборів. Набори з API-токеном підходять для інтеграцій.

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

Помилки доступу

Невірний, заблокований або прострочений токен, а також запит без необхідного заголовка повертають помилку з кодом. Значення кодів — у розділі «Помилки».

Помилки →