Перейти к основному содержанию
API-ключи позволяют аутентифицировать запросы к Публичному API Catproxy без использования пароля аккаунта. Вы можете создать несколько ключей с разными правами - например, ключ только для чтения для скрипта мониторинга и ключ с правом записи для пайплайна автоматизации. Управление ключами находится на странице API-ключи в боковом меню дашборда: Панель управления → API-ключи
Страница API Keys в дашборде Catproxy

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

Нажмите Создать API‑ключ для открытия диалога создания. Заполните три поля: Имя - описательная метка для идентификации ключа (например, Automation script, CI pipeline). Права - выберите разрешения, необходимые ключу. Разрешения сгруппированы по областям:
proxies:write не включает proxies:read - назначьте оба разрешения, если интеграция должна создавать и читать прокси. Срок действия - выберите срок действия ключа: Нажмите Создать API‑ключ для генерации ключа.

​
Сохранение ключа

После создания появится диалог Ваш новый API‑ключ с полным значением ключа и кнопкой Копировать.
API-ключ не будет показан повторно. Скопируйте его и сохраните в надёжном месте: менеджере паролей или хранилище секретов. Если ключ утерян - отзовите его и создайте новый.
Нажмите Готово для закрытия диалога. После этого в таблице будет отображаться только префикс ключа (например, cat_20fe...).

​
Просмотр и управление ключами

На странице API-ключи отображается таблица всех активных ключей со следующими столбцами: Используйте поле поиска для фильтрации ключей по имени. Столбцы можно сортировать, нажав на заголовок.
На одном аккаунте можно иметь не более 10 API-ключей. Для создания нового при достижении лимита необходимо сначала отозвать существующий ключ.

​
Отзыв ключа

Нажмите Отозвать рядом с любым ключом для открытия диалога подтверждения. Подтвердите действие, нажав Отозвать в диалоге Отозвать API‑ключ. Отзыв происходит мгновенно - все запросы с использованием этого ключа немедленно начнут возвращать 401 Unauthorized. Действие необратимо. Отзовите ключ немедленно, если:
  • Он был случайно закоммичен в репозиторий
  • Сотрудник, имевший к нему доступ, покинул команду
  • Вы подозреваете, что ключ был скомпрометирован

​
Рекомендации по безопасности

Один ключ - одна интеграция

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

Минимальные разрешения

Скрипту мониторинга нужен только stats:read. Пайплайну автоматизации - proxies:write. Никогда не выдавайте больше прав, чем необходимо.

Используйте переменные окружения

Никогда не хардкодьте ключи в исходном коде. Храните их в переменных окружения или хранилище секретов (Vault, AWS Secrets Manager и т.д.).

Задавайте срок действия

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