Ключи API

Ключ API — доступ к данным компании для вашей системы: сайта, CRM, скрипта. Выпускает его администратор компании в кабинете.

Как выпустить ключ

1. Нажмите «Выпустить ключ».

2. Назовите ключ по системе, которая будет им пользоваться: «Albato», «Сайт», «CRM».

3. Отметьте права — только те, что нужны системе (какие бывают).

4. Если ключ нужен на время, укажите срок в днях — от 1 до 3650. Пустое поле — без срока.

5. Нажмите «Выпустить» и скопируйте ключ dsk_k_…. Целиком он показывается один раз, потом в списке видно только начало.

Как передавать ключ

curl https://app.deskus.ru/api/v1/me \
  -H "Authorization: Bearer $DESKUS_KEY"

Или заголовком X-Api-Key: dsk_k_… — так удобнее некоторым коннекторам. Куки и параметры адреса для ключа не подходят.

От чьего имени работает ключ

• Ключ действует от имени сотрудника, который его выпустил: ответы клиентам подписаны им, записи «Статус: Новый → Закрыт» в ленте — тоже.

• Права ключа — те, что отметили при выпуске, но не шире прав этого сотрудника в кабинете. Сотрудника понизили до роли без тикетов — ключ тоже перестал работать с тикетами.

• Сотрудника отключили — ключ сразу перестаёт работать.

• Действия через API не открывают смену сотрудника: ночной запрос коннектора не выведет его на работу.

Как отозвать ключ

В списке ключей нажмите «Отозвать» у нужного. Ключ перестаёт работать сразу: всё, что им пользуется, получит 401 invalid_token. Подписки на события, созданные этим ключом, удаляются. Вернуть отозванный ключ нельзя — выпустите новый.

Полезно знать