Управление API-ключами
Страница API-ключей позволяет создавать, просматривать и управлять ключами, которые ваши приложения используют для вызова FourA API.
Просмотр ключей
На странице показаны все ключи, к которым у вас есть доступ:
- Личные ключи, которые вы создали напрямую.
- Ключи организации, если вы являетесь владельцем или администратором организации.
- Ключи команды, доступные вам благодаря членству в команде.
Каждая строка в таблице содержит:
| Столбец | Что отображается |
|---|---|
| Name | Отображаемое имя и (необязательное) описание |
| Key | Маскированный префикс (например, pk_live_••••••••) с кнопкой Reveal рядом |
| Owner | ME для личных ключей, TEAM для ключей организации или команды |
| IP Allowlist | Ограниченные IP-адреса, если они настроены, или «All IPs», если ограничений нет |
| Expires | Дата истечения срока действия, если она установлена, или «Never» |
| Status | Active или Inactive |
| Created | Время создания ключа |
| Last Used | Когда ключ в последний раз выполнял request |
Используйте поле поиска для фильтрации по имени или описанию, а также фильтр статуса для отображения только активных или неактивных ключей.
Создание ключа
Нажмите Create Key и заполните поля:
| Поле | Обязательное | Описание |
|---|---|---|
| Name | Да | Понятное название (например, «production-scraper» или «staging-test») |
| Description | Нет | Примечания о том, для чего используется этот ключ |
Если вы состоите в организации, вы также можете назначить ключ этой организации вместо вашей личной учетной записи.
Полный ключ показывается только один раз сразу после создания в диалоговом окне, готовом для копирования. Вы также можете просмотреть его позже с помощью кнопки Reveal (см. ниже), если ключ был создан после запуска функции reveal.
Ключи используют префикс pk_live_ и выглядят следующим образом: pk_live_a1b2c3d4e5f6.... Вы получите подтверждение по электронной почте при создании нового ключа.
Отображение ключа
Нажмите на иконку глаза рядом с маскированным префиксом ключа, чтобы снова увидеть его полный секрет. Dashboard попросит вас подтвердить действие, затем откроет диалоговое окно с ключом в открытом виде, кнопкой копирования и 15-секундным обратным отсчетом. После завершения отсчета диалоговое окно удалит секрет со страницы.
Каждое отображение ключа записывается в audit log, так как оно раскрывает действующие учетные данные.
Устаревшие ключи
Ключи, созданные до запуска этой функции, отображают иконку замка вместо глаза, и их нельзя раскрыть. Сохранялся только их хеш, поэтому исходный секрет восстановить невозможно. Чтобы обновить устаревший ключ, откройте меню действий и выберите Regenerate. С этого момента новый секрет можно будет просматривать.
Кто может просматривать ключи
| Роль | Может просматривать |
|---|---|
| Владелец ключа | Да |
| Владелец / администратор организации (для ключей организации) | Да |
Член команды с разрешением write или admin |
Да |
Член команды с разрешением read |
Нет |
Редактирование ключа
Нажмите Edit в любой строке, чтобы обновить:
- Отображаемое имя и описание
- IP allowlist (по одному IP на строку; оставьте пустым, чтобы разрешить любой исходящий IP-адрес)
- Дата истечения срока действия (оставьте пустой, чтобы срок действия не истекал)
Другие настройки (привязка к организации, владелец) не редактируются. Создайте новый ключ, если вам нужно изменить владельца.
Активация и деактивация
Используйте кнопку Disable / Enable в строке для переключения статуса ключа. Деактивация ключа блокирует все API requests, которые его используют. Вы можете повторно активировать его в любое время. Изменение вступает в силу в течение нескольких секунд.
Перевыпуск ключа
Если вы подозреваете, что ключ был скомпрометирован, откройте меню действий (кнопка с тремя точками) и выберите Regenerate. Это создаст новый секрет для того же ID ключа. Старый секрет сразу перестанет работать. Все остальные настройки (имя, привязка к организации, IP allowlist, срок действия) останутся прежними.
Новый секрет можно будет просмотреть и после закрытия диалогового окна, поэтому вам не обязательно копировать его идеально с первой попытки.
Удаление ключа
Откройте меню действий и выберите Delete. По умолчанию удаление деактивирует ключ (мягкое удаление). Вы можете окончательно удалить его в диалоговом окне подтверждения.
Вы получите уведомление по электронной почте при удалении ключа.
Ключи организации
Ключи, созданные в рамках организации, доступны ее членам в зависимости от их роли:
- Владельцы и администраторы видят и редактируют все ключи организации.
- Участники видят только те ключи, которые назначены командам, в которых они состоят.
При создании ключи организации автоматически добавляются в команду по умолчанию для этой организации.
Разрешения для ключей через команды
Команды управляют тем, кто имеет доступ к тем или иным ключам. Каждое назначение ключа команде имеет уровень разрешений:
| Разрешение | Просмотр ключа | Reveal | Редактирование настроек ключа |
|---|---|---|---|
| read | Да | Нет | Нет |
| write | Да | Да | Да |
| admin | Да | Да | Да |
Связанные разделы
- Authentication: Как API-ключи работают с API
- Organizations and Teams: Настройка общего доступа
- Dashboard Overview: Все разделы dashboard