Управление API ключами
Страница API Keys позволяет создавать, просматривать и администрировать ключи, которые ваши приложения используют для вызовов FourA API.
Просмотр ключей
На странице отображаются все ключи, к которым у вас есть доступ: ваши личные ключи и каждый ключ, принадлежащий организации, в которой вы состоите. Доступ предоставляется через членство, поэтому обычный участник также видит ключи организации.
| Столбец | Описание |
|---|---|
| Name | Отображаемое имя и описание, если оно задано |
| Owner | Personal или название организации |
| Key Prefix | Первые символы ключа, далее маска (pk_live_a1b2••••••••) с кнопкой Reveal либо иконка замка для устаревшего ключа |
| Status | Active или Inactive |
| Created | Дата и время создания ключа |
| Last Used | Дата и время последнего запроса с этим ключом |
Выполняйте поиск по имени или описанию, фильтруйте по статусам Active или Inactive, а также сортируйте по Name, Owner, Status, Created или Last Used. Направление сортировки переключается циклически: по убыванию, по возрастанию, затем отключено.
Фильтр 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.... Вы получите письмо с подтверждением создания ключа.
Ваш тариф определяет, сколько активных ключей вы можете иметь: ваши личные ключи плюс ключи организаций, которыми вы владеете. Ключ, созданный для организации, идет в зачет тарифа ее владельца. При достижении лимита в создании ключа будет отказано с сообщением, где указан лимит вашего тарифа, поэтому отключите или удалите неиспользуемый ключ либо обновите тариф.
Раскрытие ключа
Нажмите на иконку глаза рядом с маскированным префиксом ключа, чтобы снова увидеть секрет полностью. Панель управления попросит подтвердить действие, затем откроет диалоговое окно со значением ключа, кнопкой копирования и коротким таймером. По истечении таймера диалоговое окно удаляет секрет со страницы.
Каждое раскрытие записывается в журнал аудита, так как это отображает активные учетные данные.
Каждый, кому доступен ключ, может отобразить его: персональный владелец или любой участник организации, которой он принадлежит.
Устаревшие ключи
У ключей, созданных до появления функции отображения, вместо значка глаза отображается значок замка, и показать их нельзя. Хранился только их хэш, поэтому исходный секрет восстановить невозможно. Чтобы перевести устаревший ключ на новый формат, откройте меню действий и выберите Regenerate. Новый секрет можно будет просмотреть в любой момент.
Доступные действия по ролям
С личным ключом можно выполнять любые действия. Для ключей организации действуют три уровня доступа:
| Действие | Member | Admin | Owner |
|---|---|---|---|
| Использовать ключ и просматривать его | Да | Да | Да |
| Переименовывать, редактировать описание | Да | Да | Да |
| Включать или отключать | Нет | Да | Да |
| Перевыпускать секрет | Нет | Да | Да |
| Удалять | Нет | Да | Да |
| Переносить за пределы организации | Нет | Нет | Да |
Кнопки Disable и Edit остаются в строке, но отображаются серым цветом с пояснением причины. Пункты Regenerate, Transfer и Delete не появляются в меню, если они недоступны для вашей роли. API отклоняет те же действия, поэтому обойти интерфейс через интеграции не получится.
Разграничение зависит от последствий каждого действия для пользователей ключа. Переименование безопасно. Перевыпуск секрета или отключение мгновенно останавливают интеграции всех коллег. Перенос ключа за пределы организации лишает компанию доступа к нему и переводит оплату на тариф получателя, поэтому такое действие доступно только владельцу.
Редактирование ключа
Нажмите Edit, чтобы изменить имя и описание. Владелец в этом диалоговом окне не меняется: используйте Transfer.
Пункт View Metrics в меню действий открывает раздел Overview с фильтром по этому ключу.
Активация и деактивация
Используйте Disable или Enable в строке ключа. Деактивация ключа блокирует каждый запрос к API, использующий его, и вы можете включить его обратно в любой момент. Изменение вступает в силу в течение минуты.
Перевыпуск ключа
Если вы подозреваете утечку ключа, откройте меню действий и выберите Regenerate. Это создаст новый секрет для того же идентификатора ключа. Старый секрет перестанет действовать в течение минуты. Имя, владелец и все остальные настройки сохраняются.
Новый секрет можно просмотреть и после закрытия диалогового окна, поэтому его не обязательно копировать сразу.
Перенос ключа
Пункт Transfer в меню действий переносит ключ между личным владением и организацией без перевыпуска секрета. Идентификатор ключа, его метрики и история активности сохраняются. Изменяется только владелец, а вместе с ним и учет расходов.
| Перенос | Кто может выполнить |
|---|---|
| Личный ключ в организацию | Любой участник этой организации |
| Ключ организации себе | Владелец организации |
| Между двумя организациями | Владелец организации, откуда переносится ключ |
Ключ, перенесенный в организацию, добавляется в ее стандартную команду "Everyone", что делает его видимым для участников. Ключ, перенесенный за пределы организации, удаляется из всех команд, в которых он состоял.
Удаление ключа
Откройте меню действий и выберите Delete. Удаление ранее использованного ключа отключает его: ключ перестает проходить аутентификацию и остается в списке со статусом Inactive, поэтому его имя сохраняется в истории Activity и Metrics. Ключи, которые ни разу не использовались, удаляются окончательно.
После удаления ключа вы получите письмо по электронной почте.
Ключи организации и биллинг
Использование ключа, принадлежащего организации, учитывается в тарифном плане владельца организации, независимо от того, кто отправил request. На странице владельца Usage & Limits такие ключи учитываются наряду с личными и разделяются по категориям.
Связанные разделы
- Authentication: как ключи API работают с API
- Organizations: роли, участники и общий доступ
- Usage & Limits: какие ключи учитываются в вашем тарифном плане
- Dashboard Overview: все разделы панели управления