Управление ключами API
Ключи API являются уникальными идентификаторами для проверки подлинности, которые обеспечивают безопасный доступ пользователей, разработчиков или программ к API. Они необходимы для отслеживания и контроля использования API, помогают предотвратить злоупотребления и обеспечить безопасность связи.
Использование ключей API для подключения к API Qlik Cloud
Можно использовать ключи API для взаимодействия со справочником Qlik REST API. Для доступа к API можно использовать такие инструменты, как Postman или qlik-cli. Для получения дополнительной информации см. разделы Обзор API-интерфейсов Qlik и qlik-cli.
Пример: использование Postman для подключения к API Qlik.
Выполните следующие действия.
-
Запустите Postman.
-
Установите метод HTTP GET.
-
Введите URL-адрес конечной точки API Qlik Cloud.
Например, чтобы получить список всех пространств в клиенте, выполните следующие действия:
https://your-tenant.eu.qlikcloud.com/api/v1/spaces
-
На вкладке Auth (Проверка подлинности) выберите Bearer Token (Токен носителя) в поле Auth Type (Тип авторизации).
-
Введите ключ API в полеToken.
-
Щелкните Отправить.
Если запрос выполнен успешно, API вернет ответ в формате JSON. В этом примере ответ будет включать список пространств.
Включение ключей API в клиенте
Администраторы клиента могут контролировать права пользователей на генерацию ключей API в клиенте.
Выполните следующие действия.
- В центре активности Администрирование выберите Параметры.
- В разделе API-ключи включите или выключите Включить API-ключи.
Настройка параметров ключей API
Выполните следующие действия.
-
В центре активности Администрирование откройте Параметры > Ключи API.
-
При необходимости настройте следующие параметры.
-
Изменить максимальный срок действия токена: меняет срок действия созданных токенов API. Срок действия существующих ключей API остается без изменений. Для этого значения нет верхнего предела.
- Изменить максимальное количество активных ключей API на пользователя: позволяет ограничить число ключей API для пользователя. Это ограничение действует только для новых ключей. При достижении максимального значения пользователь не сможет создавать дополнительные ключи. Максимальное значение — 1000.
-
Может потребоваться обновить окно браузера, чтобы изменения отобразились в разделе Ключи API на странице профиля пользователя.
Создание ключей API и управление ими
Создание ключей API
Генерировать новые API-ключи могут пользователи с ролью, в которой есть разрешение Управлять ключами API, а также пользователь по умолчанию, если в настройках пользователя по умолчанию активно соответствующее разрешение.
Выполните следующие действия.
-
Щелкните значок профиля и выберите Параметры профиля.
-
Откройте раздел Ключи API и щелкните Создать новый ключ.
-
Добавьте описание и укажите срок действия ключа API.
-
Щелкните Создать, чтобы создать новый ключ.
-
Скопируйте созданный ключ API и сохраните его в надежном месте. Обратите внимание, что ключ нельзя будет получить в дальнейшем.
Редактирование ключей API
Можно изменить имя ключа API после его создания.
Удаление ключей API
Выполните следующие действия.
-
Щелкните значок профиля и выберите Параметры профиля.
-
Откройте раздел Ключи API.
-
Щелкните
рядом с ключом API, который требуется удалить, и выберите Удалить.
-
Для удаления всех ключей щелкните Удалить все над списком.
Мониторинг и отзыв ключей API
В разделе Ключи API в центре активности Администрирование можно посмотреть все ключи API, связанные с клиентом. Можно выполнять поиск ключей по имени, идентификатору или владельцу.
Состояния ключей API
Ключи API могут иметь следующие состояния.
- Активный: ключ API сейчас используется.
- Срок действия истек: наступила дата окончания срока действия.
- Отозванный: ключ API отозван и больше не может использоваться.
Отзыв ключей API
Администратор клиента должен активно отслеживать действия с ключами API в целях обеспечения безопасности. В случае обнаружения подозрительных действий ключ API можно отозвать.
Выполните следующие действия.
-
В центре активности Администрирование перейдите в раздел События.
-
Ищите подозрительные действия, такие как слишком частое использование определенного ключа API.
-
Щелкните
рядом с событием, чтобы развернуть сведения о нем, и скопируйте идентификатор ключа API.
-
Перейдите в раздел Ключи API и выполните поиск ключа API по его идентификатору.
-
Щелкните
рядом с ключом и выберите Отозвать. Отозвать можно только ключи со статусом «Активный».
-
Чтобы отозвать несколько ключей API, выберите их в таблице и щелкните Отозвать в верхнем правом углу.
Рекомендации по управлению ключами API
-
Обеспечивайте конфиденциальность ключей: храните ключи API в безопасном месте и не раскрывайте их в репозиториях с общедоступным кодом.
-
Регулярно создавайте ключ заново: периодически обновляйте ключи API для повышения безопасности.
-
Отслеживайте использование: регулярно проверяйте действия с ключами API, чтобы выявлять подозрительное поведение.