API-ключи проекта

Кратко

Путь: "Настройки" -> "API".

API-ключи нужны для внешних интеграций, которые обращаются к API проекта.

Список API-ключей показывает

название;
замаскированный префикс;
разрешения;
статус: «Активен», «Неактивен» или «Истёк»;
дату создания;
последнее использование;
срок действия.

Создание API-ключа

откройте создание ключа;
укажите название;
выберите разрешения;
при необходимости задайте дату истечения;
сохраните ключ и сразу скопируйте его.

Важно

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

Разрешения

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

Право просмотра текущего проекта обязательно для проектного API-ключа. Оно заблокировано в форме и всегда сохраняется при создании или редактировании ключа. Если нажать "Снять все", снимутся только необязательные права.

Для просмотра списка ключей нужен доступ к API-ключам проекта. Для создания, редактирования и удаления нужен доступ к управлению ими. Если действия недоступны, проверьте роль участника проекта.

Редактирование API-ключа

откройте редактирование нужного ключа;
можно изменить название;
можно изменить разрешения;
можно включить или выключить активность.

Удаление

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

Если интеграция получает 401/403

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

Где это в интерфейсе

Основные элементы раздела:

страница API-ключей
страница создания API-ключа
страница редактирования API-ключа
название API-ключа
разрешения API-ключа
срок действия API-ключа
активность API-ключа
сохранение API-ключа
создание API-ключа
API-ключ в списке
редактирование API-ключа
удаление API-ключа
подтверждение удаления API-ключа
копирование нового API-ключа
страница настроек проекта
пункт «Настройки» в боковом меню