Управление API-ключами
Страница API Keys позволяет создавать, просматривать и управлять ключами, которые ваши приложения используют для вызова FourA API.
Просмотр ваших ключей
На странице показаны все ключи, к которым у вас есть доступ:
- Personal keys (Личные ключи), которые вы создали напрямую.
- Organization keys (Ключи организации), если вы являетесь владельцем или администратором организации, или если ключ, которым вы владеете, был передан одной из ваших организаций.
Каждая строка в таблице показывает:
| Column | What it shows |
|---|---|
| Name | Отображаемое имя и (необязательное) описание |
| Key | Маскированный префикс (например, pk_live_••••••••) с кнопкой Reveal рядом с ним |
| Owner | Personal для личных ключей или имя организации для ключей, принадлежащих организации |
| Status | Active (Активен) или Inactive (Неактивен) |
| Created | Когда ключ был создан |
| Last Used | Когда ключ в последний раз выполнял request |
Используйте поле поиска для фильтрации по имени или описанию, а также фильтр статуса для отображения только активных или неактивных ключей. Каждый заголовок столбца можно сортировать.
Создание ключа
Нажмите Create Key и заполните:
| Field | Required | Description |
|---|---|---|
| Name | Yes | Описательная метка (например, "production-scraper" или "staging-test") |
| Description | No | Заметки о том, для чего используется этот ключ |
| Owner | Yes, если вы состоите в организации | Personal (Личный) или одна из организаций, к которым вы принадлежите. Выбор появляется только тогда, когда у вас есть хотя бы одна организация. |
Полный ключ отображается один раз сразу после создания в диалоговом окне, готовом к копированию. Вы также можете снова вызвать его позже с помощью Reveal (см. ниже).
Ключи используют префикс pk_live_ и выглядят как pk_live_a1b2c3d4e5f6.... При создании нового ключа вы получите подтверждение по электронной почте.
Раскрытие ключа
Нажмите значок глаза рядом с маскированным префиксом ключа, чтобы снова увидеть его полный секрет. Панель управления просит вас подтвердить действие, затем открывает диалоговое окно с открытым ключом, кнопкой копирования и коротким обратным отсчетом. По истечении обратного отсчета диалоговое окно удаляет секрет со страницы.
Каждое раскрытие записывается в журнал аудита, поскольку оно раскрывает действующие учетные данные.
Устаревшие ключи (Legacy Keys)
Ключи, созданные до появления функции раскрытия, показывают значок замка вместо глаза и не могут быть раскрыты. Был сохранен только их хэш, поэтому исходный секрет невозможно восстановить. Чтобы переключить устаревший ключ, нажмите меню действий и выберите Regenerate. С этого момента новый секрет можно будет раскрыть.
Кто может раскрывать
| Role | Can reveal |
|---|---|
| Key owner (Владелец ключа) | Yes |
| Org owner or admin (Владелец или администратор организации) (для ключей организации) | Yes |
| Anyone else (Кто-либо еще) | No |
Редактирование ключа
Нажмите Edit в любой строке, чтобы обновить отображаемое имя и описание. Право собственности (личное в отличие от организации) здесь не изменяется. Используйте Transfer ниже для перемещения ключа между владельцами.
Активация и деактивация
Используйте кнопку Disable / Enable в строке, чтобы переключить статус ключа. Деактивация ключа блокирует все API requests, которые его используют. Вы можете повторно активировать его в любое время. Изменение вступает в силу в течение нескольких секунд.
Повторное создание ключа (Regenerating)
Если вы подозреваете, что ключ был скомпрометирован, откройте меню действий (кнопка с тремя точками) и выберите Перевыпустить (Regenerate). Это создаст новый секрет для того же ID ключа. Старый секрет немедленно перестанет работать. Имя, привязка к организации и другие настройки останутся прежними.
Новый секрет можно будет просмотреть даже после закрытия диалогового окна, поэтому вам не нужно копировать его идеально с первого раза.
Передача ключа
В каждой строке меню есть действие Передать (Transfer). Используйте его для перемещения ключа между личным владением и владением организации без перевыпуска секрета. ID ключа, его метрики и история активности сохраняются, меняется только владелец.
Частые случаи:
- Перемещение личного ключа, созданного для общего проекта, в организацию, чтобы коллега мог управлять им после вас.
- Возврат ключа организации себе, если проект отделяется.
Вы можете передать свой (личный) ключ в любую организацию, где вы являетесь владельцем или администратором, а также можете передать администрируемый вами ключ организации себе или между администрируемыми организациями.
Удаление ключа
Откройте меню действий и выберите Удалить (Delete). Удаление ранее использовавшегося ключа приводит к его мягкому удалению: ключ перестает проходить аутентификацию, но его история активности (Activity) и метрик (Metrics) остается нетронутой. Ключи, которые никогда не использовались, можно удалить полностью.
Вы получите уведомление по электронной почте при удалении ключа.
Ключи организации
Ключи, принадлежащие организации, видны владельцам и администраторам организации. Участники без роли владельца или администратора их не видят.
Использование ключа организации учитывается в тарифе владельца организации.
Связанные материалы
- Аутентификация: как API-ключи работают с API
- Организации и команды: настройка общего доступа
- Обзор панели управления: все разделы панели управления