API-ключи проекта
Как открыть список
На странице «Основные» найдите карточку API и нажмите «Настройки».
Откроется страница API-ключей проекта.
В каждой карточке ключа показаны:
- название;
- замаскированный префикс;
- выданные разрешения;
- статус «Активен», «Неактивен» или «Истёк»;
- дата создания;
- дата последнего использования или «Никогда»;
- дата истечения или «Не истекает».
Статус «Истёк» определяется датой истечения, даже если сам ключ не был выключен.
Как создать ключ
Нажмите «Создать API-ключ».
На странице создания:
- Введите название.
- В разрешениях оставьте только доступы, необходимые интеграции.
- При необходимости задайте дату истечения. Пустое поле создаёт ключ без срока окончания.
- Нажмите «Создать API-ключ».
После успешного создания откроется окно с полным значением. Нажмите копирование и сохраните ключ в защищённом хранилище. После закрытия окна список показывает только префикс; полного значения в интерфейсе больше нет.
Как работают разрешения
Разрешения сгруппированы по сущностям. «Выбрать все» добавляет все доступные необязательные права, включая права изменения; «Снять все» убирает только необязательные права.
Обязательное проектное разрешение заблокировано в селекторе и сохраняется при создании и редактировании. Это поведение задаётся интерфейсом формы, поэтому снять его нельзя.
Используйте минимально достаточный набор разрешений. Не передавайте полный ключ в документации, переписке или обращении в поддержку.
Редактирование
У нужного ключа нажмите значок редактирования. На странице редактирования можно:
- изменить название;
- изменить разрешения;
- включить или выключить ключ через переключатель статуса.
Дата истечения на странице редактирования не изменяется. После сохранения запросы используют новый статус и набор разрешений.
Удаление
Нажмите значок удаления, проверьте название ключа в окне и подтвердите действие через «Удалить». После удаления запросы с этим ключом больше не авторизуются.
Если ключ мог попасть посторонним, безопаснее удалить его и создать новый, а не только переименовать.
Если интеграция получает 401 или 403
Проверьте по порядку:
- интеграция использует полное значение актуального ключа;
- ключ активен и срок действия не истёк;
- ключ создан в нужном проекте;
- у ключа есть разрешение на вызываемую операцию;
- после замены ключа интеграция действительно сохранила новое значение.