Перейти к основному содержимому Перейти к дополнительному содержимому
Ресурсы Qlik

Управление ключами API

Ключи API являются уникальными идентификаторами для проверки подлинности, которые обеспечивают безопасный доступ пользователей, разработчиков или программ к API. Они необходимы для отслеживания и контроля использования API, помогают предотвратить злоупотребления и обеспечить безопасность связи.

Использование ключей API для подключения к API Qlik Cloud

Можно использовать ключи API для взаимодействия со справочником API REST на сайте qlik.dev. Для доступа к API можно использовать такие инструменты, как Postman или qlik-cli. Для получения дополнительной информации см. разделы Обзор API-интерфейсов Qlik и qlik-cli.

Пример: использование Postman для подключения к API Qlik.

Выполните следующие действия.

  1. Запустите Postman.

  2. Установите метод HTTP GET.

  3. Введите URL-адрес конечной точки API Qlik Cloud.

    Например, чтобы получить список всех пространств в клиенте, выполните следующие действия:

    https://your-tenant.eu.qlikcloud.com/api/v1/spaces

  4. На вкладке Auth (Проверка подлинности) выберите Bearer Token (Токен носителя) в поле Auth Type (Тип авторизации).

  5. Введите ключ API в поле Token (Токен).

  6. Щелкните Отправить.

Если запрос выполнен успешно, API вернет ответ в формате JSON. В этом примере ответ будет включать список пространств.

Включение ключей API в клиенте

По умолчанию создание ключей API отключено. Администраторы клиента должны включить ключи API в клиенте, чтобы пользователи могли их создавать.

Выполните следующие действия.

  1. В центре активности Администрирование выберите Параметры.
  2. В разделе Ключи API выберите Включить ключи API.

  3. При необходимости настройте следующие параметры.

    • Изменить максимальный срок действия токена: изменяет срок действия вновь созданных токенов. Срок действия существующих ключей API остается без изменений. Максимальный предел для значения не установлен.

    • Изменить максимальное количество активных ключей API на пользователя: это ограничение применяется только к новым ключам API. В случае достижения предельного значения создание дополнительных ключей API будет запрещено. Максимально допустимое значение — 1000.
    Примечание к информацииМожет потребоваться обновить окно браузера, чтобы изменения отобразились в разделе Ключи API на странице профиля пользователя.

  4. Чтобы приступить к созданию ключей API, щелкните Создать новый. Откроется раздел Ключи API в профиле пользователя.

Создание ключей API и управление ими

Создание ключей API

Для создания новых ключей API требуется роль Разработчик. Администраторы клиента могут назначать роли пользователям.

Выполните следующие действия.

  1. Щелкните значок профиля и выберите Параметры профиля.

  2. Откройте раздел Ключи API и щелкните Создать новый ключ.

  3. Добавьте описание и укажите срок действия ключа API.

  4. Щелкните Создать, чтобы создать новый ключ.

  5. Скопируйте созданный ключ API и сохраните его в надежном месте. Обратите внимание, что ключ нельзя будет получить в дальнейшем.

Редактирование ключей API

Можно изменить имя ключа API после его создания.

Удаление ключей API

Примечание к информацииУдаление ключей API является необратимым и не может быть отменено. Убедитесь, что это действие не нарушит выполняемые в данный момент процессы или интеграции, в которых используется данный ключ.

Выполните следующие действия.

  1. Щелкните значок профиля и выберите Параметры профиля.

  2. Откройте раздел Ключи API.

  3. Щелкните Дополнительно рядом с ключом API, который требуется удалить, и выберите Удалить.

  4. Для удаления всех ключей щелкните Удалить все над списком.

Мониторинг и отзыв ключей API

В разделе Ключи API в центре активности Администрирование можно посмотреть все ключи API, связанные с клиентом. Можно выполнять поиск ключей по имени, идентификатору или владельцу.

Состояния ключей API

Ключи API могут иметь следующие состояния.

  • Активный: ключ API сейчас используется.
  • Срок действия истек: наступила дата окончания срока действия.
  • Отозванный: ключ API отозван и больше не может использоваться.

Отзыв ключей API

Администратор клиента должен активно отслеживать действия с ключами API в целях обеспечения безопасности. В случае обнаружения подозрительных действий ключ API можно отозвать.

Примечание к информацииОтзыв ключа API приводит к его немедленной деактивации, затрагивая все выполняемые в данный момент процессы или интеграции, в которых он используется. Процедура отзыва необратима, отозванный ключ API невозможно активировать повторно.

Выполните следующие действия.

  1. В центре активности Администрирование перейдите в раздел События.

  2. Ищите подозрительные действия, такие как слишком частое использование определенного ключа API.

  3. Щелкните Стрелка вниз рядом с событием, чтобы развернуть сведения о нем, и скопируйте идентификатор ключа API.

  4. Перейдите в раздел Ключи API и выполните поиск ключа API по его идентификатору.

  5. Щелкните Дополнительно рядом с ключом и выберите Отозвать. Отозвать можно только ключи со статусом «Активный».

  6. Чтобы отозвать несколько ключей API, выберите их в таблице и щелкните Отозвать в верхнем правом углу.

Рекомендации по управлению ключами API

  • Обеспечивайте конфиденциальность ключей: храните ключи API в безопасном месте и не раскрывайте их в репозиториях с общедоступным кодом.

  • Регулярно создавайте ключ заново: периодически обновляйте ключи API для повышения безопасности.

  • Отслеживайте использование: регулярно проверяйте действия с ключами API, чтобы выявлять подозрительное поведение.

Помогла ли вам эта страница?

Если вы обнаружили какую-либо проблему на этой странице и с ее содержанием — будь то опечатка, пропущенный шаг или техническая ошибка, сообщите нам об этом, чтобы мы смогли ее исправить!

Оставьте свой отзыв здесь