Настройка API-канала

Чтобы создать API-канал, откройте раздел «Каналы» → «Добавить канал»:


Затем выберите пункт «API»:


После добавления канала на странице появляются три блока для настройки: «API», «Отслеживание запросов» и «Отслеживание чатов».

Блок «API»


  • Название канала — введите название канала, которое будет отображаться в общем списке каналов в разделе «Каналы»;
  • Redirect URL — ваш вебхук, на который API-канал Юздеска должен отправлять запросы, когда возникают конкретные события по отслеживаемым каналам (их список вы определяете в блоках «Отслеживание запросов», «Отслеживание чатов»);
  • JSON запрос — отметьте чекбокс, если нужно преобразовывать запрос в формат JSON;
  • Отправлять в UTF-8 — отметьте чекбокс для отправки запроса именно в этом формате;
  • Следить за каналами — перенесите в правый столбец те каналы Юздеска, по которым этот API-канал должен отслеживать события, отмеченные чекбоксами в блоках «Отслеживание запросов» и «Отслеживание чатов». Ненужные каналы оставьте в левом столбце. Такое разграничение позволит снизить нагрузку на API-канал и избавиться от лишних данных.

Блоки «Отслеживание запросов» и «Отслеживание чатов»
Отметьте чекбоксы тех событий, при которых канал должен отправлять запросы на ваш Redirect URL.


После внесения всех изменений нажмите «Сохранить».

После сохранения в блоке API появляются поля:

  • ID приложения,
  • секретный ключ — это токен API-канала, через который можно работать с API.

Была ли статья полезна?

Да Нет