Управление ключами API | Qlik Cloud Справка
Перейти к основному содержимому Перейти к дополнительному содержимому
Ресурсы Qlik
Загрузка поиска SearchUnify Если вам нужна помощь с вашим продуктом, обратитесь в поддержку Qlik.
Портал клиентов Qlik
Загрузка поиска SearchUnify Если вам нужна помощь с вашим продуктом, обратитесь в поддержку Qlik.
Портал клиентов Qlik

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

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

video thumbnail

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

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

Примечание к информации

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

Пример: Использование 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. Нажмите Send.

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

Настройка параметров ключей API

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

  1. В центре активности Администрирование перейдите на страницу Настройки.

  2. Выберите вкладку Управление функциями.

  3. В разделе Ключи API настройте следующие параметры по мере необходимости:

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

    • Изменить максимальное количество активных ключей API на пользователя: Установите ограничение на количество ключей API, которое может иметь пользователь. Это ограничение применяется только к новым ключам. Если ограничение достигнуто, пользователи не смогут создавать дополнительные ключи. Максимальное значение — 1000.

Возможно, потребуется обновить браузер, чтобы увидеть изменения, отраженные в разделе Ключи 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 для выявления любого подозрительного поведения.

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

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

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