Управление API-ключами
Страница API Keys позволяет создавать, просматривать и администрировать ключи, используемые вашими приложениями для вызова FourA API.
Просмотр ключей
На странице отображаются все доступные вам ключи: ваши личные ключи и все ключи организаций, в которых вы состоите. Доступ определяется членством, поэтому обычный участник также видит ключи организации.
| Столбец | Что отображает |
|---|---|
| Name | Отображаемое имя и описание, если оно задано |
| Owner | Personal или название организации |
| Key Prefix | Маскированный префикс (pk_live_••••••••) с кнопкой Reveal или значок замка для устаревшего ключа |
| Status | Active или Inactive |
| Created | Время создания ключа |
| Last Used | Время последнего запроса с использованием ключа |
Выполняйте поиск по имени или описанию, фильтруйте по статусам Active или Inactive и сортируйте по любому заголовку. Порядок сортировки переключается циклически: по убыванию, по возрастанию, затем отключено.
Фильтр Owner
Если вы состоите хотя бы в одной организации, рядом с полем поиска появляется выпадающий список Owner: Everything, Personal или по одному пункту для каждой организации. Он фильтрует список ключей по выбранному владельцу. Этот же элемент управления на страницах Overview, Metrics, Activity и Proxy синхронизируется с вашим выбором, поэтому на всех пяти страницах всегда отображаются данные одного и того же владельца.
Создание ключа
Нажмите Create Key над списком (Create API key на пустой странице перед созданием первого ключа) и заполните поля:
| Поле | Обязательное | Описание |
|---|---|---|
| Name | Да | Понятное имя, например "production-scraper" или "staging-test" |
| Description | Нет | Заметки о назначении этого ключа |
| Owner | Да, если вы состоите в организации | Personal или любая организация, в которой вы состоите. Выбор отображается только при наличии хотя бы одной организации. |
Любой участник организации может создать ключ, принадлежащий ей, независимо от роли. В этом и заключается суть настройки: расходы по ключу организации списываются с владельца организации, поэтому разработчику не нужен личный ключ, по которому счета тайно выставлялись бы ему, а не компании.
Полный ключ отображается один раз сразу после создания в диалоговом окне для копирования. Позже его можно просмотреть снова с помощью кнопки Reveal. Ключи используют префикс pk_live_ и имеют вид pk_live_a1b2c3d4e5f6.... Вы получите электронное письмо с подтверждением создания ключа.
Отображение ключа
Нажмите значок глаза рядом с маскированным префиксом ключа, чтобы снова увидеть его полный секрет. Панель управления запросит подтверждение, затем откроет диалоговое окно с открытым ключом, кнопкой копирования и коротким таймером обратного отсчета. По истечении таймера диалоговое окно удалит секрет со страницы.
Каждое отображение ключа фиксируется в журнале аудита, так как оно открывает активные учетные данные.
Отобразить ключ может любой пользователь, которому он доступен: его личный владелец или любой участник организации, владеющей им.
Устаревшие ключи
Ключи, созданные до появления функции просмотра, отображают значок замка вместо глаза, и их нельзя просмотреть. Сохранялся только их хеш, поэтому исходный secret восстановить невозможно. Чтобы обновить устаревший ключ, откройте меню действий и выберите Regenerate. После этого новый secret можно будет просматривать в любое время.
Что разрешено каждой роли
Для личного ключа доступно всё. Для ключа организации действуют три уровня:
| Действие | Member | Admin | Owner |
|---|---|---|---|
| Использовать ключ и просматривать его | Да | Да | Да |
| Переименовывать, изменять описание | Да | Да | Да |
| Включать или отключать | Нет | Да | Да |
| Перегенерировать secret | Нет | Да | Да |
| Удалять | Нет | Да | Да |
| Переносить за пределы организации | Нет | Нет | Да |
Кнопки Disable и Edit остаются в строке, но становятся неактивными с пояснением причины. Пункты Regenerate, Transfer и Delete отсутствуют в меню, если они недоступны для вашей роли. API отклоняет те же действия, поэтому интеграция не сможет обойти интерфейс.
Разделение прав основано на том, как действие влияет на пользователей ключа. Переименование безопасно. Перегенерация или отключение мгновенно ломает интеграции всех коллег. Перенос ключа наружу забирает его у компании и переводит расходы на личный тариф пользователя, поэтому доступен только владельцу (Owner).
Редактирование ключа
Нажмите Edit, чтобы изменить имя и описание. Владелец в этом окне не меняется: используйте Transfer.
Пункт View Metrics в меню действий открывает Overview с фильтром по этому ключу.
Активация и отключение
Используйте Disable или Enable в строке ключа. Отключение ключа блокирует каждый API request с его использованием, и вы можете включить его снова в любое время. Изменение вступает в силу за несколько секунд.
Перегенерация ключа
Если есть подозрение на утечку ключа, откройте меню действий и выберите Regenerate. Будет создан новый secret для того же key ID. Старый secret сразу перестает работать. Имя, владелец и все остальные параметры остаются прежними.
Новый secret можно просмотреть и после закрытия диалога, поэтому копировать его немедленно необязательно.
Перенос ключа
Пункт Transfer в меню действий переносит ключ между личным владением и организацией без перегенерации secret. Key ID, его метрики и история активности сохраняются. Меняется только владелец, а вместе с ним и аккаунт для списания расходов.
| Перенос | Кто может выполнить |
|---|---|
| Личный ключ в организацию | Любой участник этой организации |
| Ключ организации себе | Владелец (Owner) организации |
| Между двумя организациями | Владелец (Owner) исходной организации |
Ключ, перенесенный в организацию, попадает в стандартную команду "Everyone", что делает его видимым для участников. Ключ, перенесенный наружу, удаляется из всех команд, где он находился.
Удаление ключа
Откройте меню действий и выберите Delete. Удаление ранее использованного ключа отключает его: ключ перестает проходить аутентификацию и остается в списке со статусом Inactive, сохраняя свое имя в истории Activity и Metrics. Ключи, которые ни разу не использовались, удаляются навсегда.
При удалении ключа вы получите письмо по электронной почте.
Ключи организации и биллинг
Использование ключа организации учитывается в тарифном плане владельца организации независимо от того, кто отправил запрос. На странице Usage & Limits владельца такие ключи учитываются наряду с личными и разделяются на две категории.
Связанные разделы
- Authentication: как API ключи работают с API
- Organizations: роли, участники и общий доступ
- Usage & Limits: какие ключи учитываются в вашем тарифном плане
- Dashboard Overview: все разделы дашборда