Авторизация в API

Авторизация от имени интеграции (по API-ключу)

Такой способ авторизации позволяет получить доступ к конкретным разделам API в рамках одной компании, для которой был выдан ключ. Все действия, совершённые с использованием API-ключей, совершаются от имени владельца компании.

Чтобы получить API-ключ, необходимо в личном кабинете перейти в "Настройки" -> "Интеграции" и выбрать в доступных интеграциях "API".

Права доступа (scopes):

  1. connections - Подключения. Даёт возможность просматривать список подключений, менять их настройки и создавать новые.

  2. integrations - Интеграции. Даёт возможность просматривать список интеграций и управлять их настройками.

  3. messaging - Сообщения. Даёт доступ на просмотр и создание чатов, на просмотр и отправку сообщений, на управление шаблонами сообщений.

  4. members - Сотрудники. Даёт доступ к списку сотрудников компании.

  5. sales - Продажи. Даёт доступ к управлению товарами/каталогами/магазинами.

  6. webhooks - Вебхуки. Даёт доступ на создание, редактирование и удаление вебхуков.

  7. partners - Партнёрка. Даёт доступ к управлению настройками партнёра и его клиентов.

Пример ключа: dRuxlQOV6lZUi1X90py_JqsVXuIkJ-UB6nHhb0H5T-Da0To50CnyqP8d_Xs-KCcSoFvdlKRbu0STWYOe8-A6Pw

Этот ключ нужно подставлять во все запросы к API в заголовок X-Api-Key.

Last updated