API-ключи

Назначение. API-ключ — пароль для программ. С ним скрипт, интеграция или ИИ-ассистент работает с Assist в пределах прав роли, выбранной для ключа.

Кто видит. Каждый видит свои ключи. Администратор видит ключи всех, если у роли есть право.

Как открыть. Кнопка API-ключи в шапке справа.

Что на экране

1. Создать ключ открывает форму.
2. Подключить к ИИ создаёт ключ и показывает готовые настройки для ИИ-ассистента: «Интеграции».
3. Название — понятное имя.
4. Владелец и Роль: ключ действует с правами роли, а не вашей учётной записи.
5. Статус: «Активен», «Отозван», «Истёк».
6. Key — начало токена для опознания. Полный токен не показывается.
7. Использован — когда ключ применяли в последний раз. «Никогда» — ещё не использовался.
8. Истекает — до какого момента ключ работает.
9. Перевыпустить и Отозвать.

Пока ключей нет, кабинет пишет «Пока нет API-ключей».

Как создать ключ

1. Нажмите Создать ключ.
2. Введите Название, например «Интеграция с CRM».
3. Выберите Роль. Можно выбрать свою роль или роль с более низким приоритетом: ключ не получит больше прав, чем у вас. Если подходящих ролей нет, обратитесь к администратору.
4. Выберите Срок действия: «Бессрочно», 30, 90 или 365 дней.
5. Нажмите Создать ключ.
6. Скопируйте токен кнопкой Скопировать. Кабинет показывает полный токен один раз. Если потеряли, перевыпустите ключ.

Перевыпуск и отзыв

• Перевыпустить. Создаёт новый токен, старый перестаёт работать сразу. Обновите токен в интеграциях.
• Отозвать. Ключ перестаёт работать навсегда. Необратимо, интеграции с ним остановятся.

Число активных ключей ограничено: при достижении лимита кабинет сообщит.

Безопасность

• Не отправляйте токен в мессенджерах и не храните в репозитории.
• Давайте ключу роль с минимально нужными правами.
• Создавать, перевыпускать и отзывать ключи можно только в интерфейсе, самим ключом это сделать нельзя.

См. также

• Интеграции.
• API и интеграции: справочник.