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

Кратко

В боковом меню откройте «Настройки», затем на странице настроек проекта выберите «API».

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

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

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

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

• нажмите кнопку создания ключа, чтобы открыть страницу создания;
• укажите название;
• выберите разрешения;
• при необходимости задайте дату истечения;
• при необходимости измените активность ключа;
• нажмите «Сохранить» и сразу скопируйте новый ключ.

Важно

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

Разрешения

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

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

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

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

• у нужного ключа нажмите «Редактировать», чтобы открыть страницу редактирования;
• можно изменить название;
• можно изменить разрешения;
• можно включить или выключить активность.

Удаление

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

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

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