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

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

[Managing API keys in Qlik Cloud](https://play.vidyard.com/FY9N3NwFQKALEcSBp3Bxy6)

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

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

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

Учетные данные API обеспечивают прямой программный доступ к Qlik Cloud и не ограничиваются рабочими процессами, доступными в пользовательском интерфейсе. Назначайте роли и области действия OAuth, используя принцип наименьших привилегий. Относитесь к сервисным учетным записям и учетным данным API с такой же осторожностью, как к учетным данным администратора. Для получения дополнительной информации см. раздел [Управление доступом к API и границы доверия](https://qlik.dev/manage/access-control/api-trust-boundaries/).

Пример: использование 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

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

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. Щелкните the Дополнительно icon рядом с ключом API, который требуется удалить, и выберите Удалить.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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