Как выдать и отозвать API-токен интеграции

Как получить ключ для API-интеграции, безопасно передать его разработчику и отозвать при необходимости.

Перед началом

Учётная запись с доступным управлением API-токеном и действующим подходящим тарифом.
Понимание, какой внешней интеграции нужен доступ.

API-токен и виджет — разные подключения

API-токен нужен программе, которая обращается к API от имени вашей учётной записи. Код виджета на сайт использует своё подключение. Не подставляйте один токен вместо другого. С ключом нужно обращаться как с паролем.

Создайте токен

Откройте свой профиль (/my/profile), прокрутите до раздела доступа к API. Не путайте его с расположенным рядом доступом к виджету.
Если токен ещё не выпущен, выберите создание нового.
Дождитесь результата. Если программа сообщила об ограничении тарифа, прочитайте причину и проверьте условия доступа.
Скопируйте токен соответствующей кнопкой и передайте только разработчику нужной интеграции через защищённый канал.
Откройте документацию API из этого же блока и проверьте подключение по инструкции интегратора.

Кнопки управления API-токеном. Сам ключ исключён из кадра. Нажмите на снимок, чтобы увеличить.

Замените или отзовите доступ

Перед заменой ключа выясните, какие интеграции его используют.
Для перевыпуска существующего ключа нажмите «Сгенерировать новый» и прочитайте предупреждение: текущий ключ перестанет работать сразу после подтверждения. Интеграции нужно будет переключить на новый ключ.
Передайте новый ключ ответственному разработчику и проверьте работу интеграции.
Для прекращения доступа выберите отзыв токена и подтвердите действие.
Убедитесь, что ненужная интеграция больше не использует прежний доступ.

Предупреждение о перевыпуске API-токена. Нажмите на снимок, чтобы увеличить.

Если ключ попал в открытый доступ

Отзовите или замените его и обновите все разрешённые интеграции. Удаление изображения или сообщения с ключом не заменяет отзыв самого ключа. В публичных инструкциях и заявках в поддержку показывайте только маскированное значение.

Если показываете экран коллегам или в публичной инструкции, предварительно закройте значение ключа: кабинет может показывать его целиком.

Как проверить результат

Ключ выдан только нужной интеграции; при замене или отзыве проверено, какие подключения продолжили работать.

Если не получилось

Токен не выдаётся: прочитайте ограничение тарифа или срока и не используйте ключ виджета как обход.
Интеграция перестала работать после перевыпуска: обновите ключ у её ответственного разработчика.
Копирование недоступно: проверьте, что выпуск завершился успешно.