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

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

Обзор страницы «Ключи API»

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

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

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

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

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

По умолчанию ключи API отключены. Администраторы клиента могут активировать ключи API в клиенте.

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

1. В Консоль управления перейдите в раздел Параметры.
2. Перейдите к разделу Ключи API и выберите Включить ключи API.
3. При необходимости настройте следующие параметры:

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

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

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

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

Ключи API можно создавать в хабе. Прежде чем начать, следует убедиться, что выполнены следующие условия:

• Имеется активная лицензия.

• Активен параметр Включить ключи API в Консоль управления.
• Вам назначена роль Разработчик.

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

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

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

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

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

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

После создания можно будет изменить имя ключа API или совсем его удалить в случае необходимости.

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

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

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

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

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

1. В Консоль управления перейдите к разделу События.

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

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

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

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

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

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

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

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

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

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

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

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

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