Ключ доступа — это строка символов, по которой Битрикс24 узнает ваше приложение. Без ключа приложение не может читать сделки, создавать задачи или отправлять сообщения. Как только ключ отзывают — приложение перестает получать данные.
В статье расскажем:
Какие типы ключей есть в Вайбкоде
В Вайбкоде три типа ключей, каждый под свой сценарий.
API-ключ (vibe_api_) — подходит, когда приложение делаете только для себя: личный дашборд, скрипт, серверная интеграция или бот на своем портале. Привязан к одному порталу Битрикс24, все запросы идут от вашего имени. Найти его можно в разделе Ключи API.
Ключ авторизации (vibe_app_) — для приложений, которыми пользуются коллеги или несколько порталов. Каждый пользователь проходит авторизацию, и запросы идут от его имени — со своими правами и ограничениями. Такой ключ подходит для приложений из каталога, которые работают на разных порталах под разными пользователями.
Менеджмент-ключ (vibe_live_) — для администрирования платформы: управления ключами, просмотра порталов, работы с обратной связью. Не привязан к одному порталу. Не дает доступа к данным Битрикс24 — сделкам, задачам и другим сущностям. Создается в разделе Менеджмент-ключи.
Разделение на типы нужно, чтобы при утечке одного ключа остальное продолжало работать:
- Ключ для личных автоматизаций попал в открытый репозиторий — под угрозой только ваши личные приложения, приложения команды не затронуты.
- Ключ приложения попал не в те руки — отзываете именно его и выпускаете новый, остальные приложения не трогаете.
- Служебный ключ платформы недоступен извне — скопировать его из переписки или кода невозможно.
Уроки, обучение, полезные истории, кейсы и эксклюзивные эфиры — все в канале Max для пользователей «Битрикс24 печатает»
Как работают ключи при совместном доступе
Когда делитесь приложением — с коллегой, отделом или другим Битрикс24 — Вайбкод не передает ваш ключ. Платформа выпускает отдельный ключ для каждого получателя. Это значит:
- Получатель видит только то, что разрешено в настройках приложения. К вашим данным доступа у него нет.
- Если получатель удалит приложение — отзывается только его ключ, ваш не трогается.
- Чтобы закрыть доступ конкретному получателю — отзываете только его ключ, остальные продолжают работать.
Как управлять ключами
Откройте раздел API-ключи в боковом меню Вайбкода. Здесь видно все ключи, связанные с приложением: ваши и ключи получателей, если открыли совместный доступ.
У каждого ключа есть метаданные: кому выдан, когда выпущен, когда последний раз использовался и какие права имеет. По ним легко понять, какие ключи активны, а какие можно отозвать.
Отзовите ключ, если:
- сотрудник с доступом ушел из компании,
- ключ попал в переписку, скриншот или открытый код,
- приложение больше не нужно,
- хотите перевыпустить ключ планово — например, раз в год.
Как отозвать ключ и закрыть доступ
Коротко
- Ключ — это строка символов, по которой Битрикс24 узнает ваше приложение.
- В Вайбкоде три типа ключей: API-ключ для личных автоматизаций, ключ авторизации для приложений с совместным доступом, менеджмент-ключ для администрирования платформы.
- Разные типы нужны, чтобы при утечке одного ключа остальное продолжало работать.
- При совместном доступе каждый пользователь получает свой ключ — ключ автора не передается.
- Все ключи видны в разделе API-ключи в боковом меню Вайбкода.