Перейти к основному содержимому

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

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

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

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

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

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

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

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

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

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

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

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

Параметр Включить ключи API можно включить на странице Параметры в Management Console. По умолчанию ключи API отключены в Management Console.

Свойства для ключей API
Свойство Описание
Включить APIключи

Этот переключатель включает или выключает все ключи API в клиенте. Активировать ключи API может только администратор клиента.

Изменить срок действия токена

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

Изменить максимальное число ключей API на одного пользователя

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

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

  1. В Management Console перейдите на страницу Параметры.
  2. В разделе Ключи API переместите кнопку-переключатель Активировать ключи API (Enable API keys) во включенное положение.
  3. Если применимо, измените настройки Изменить максимальный срок действия токена и Изменить максимальное число ключей на одного пользователя.

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

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

  • Используется лицензия. Лицензия необходима для создания ключа API.

  • Параметр Включить API ключи включен в Management Console.
  • Администратор клиента назначил вам роль разработчика.

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

  1. Войдите в свой клиент, например https://<tenantname>.com.

  2. Щелкните свой профиль в правом верхнем углу и выберите Параметры профиля.

  3. Выберите Ключи API.

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

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

  6. Щелкните Создать.

    Будет создан ключ API.

  7. Скопируйте ключ API и сохраните в безопасном месте.

После создания можно изменить имя ключа API. Кроме того, можно удалить ключ.