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

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

НА ЭТОЙ СТРАНИЦЕ

Управление ключами 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.

Properties for API keys
Property Description
Enable API keys

This switch enables or disables all the API keys in the tenant. Only the tenant admin can enable the API keys.
Change maximum token expiration

By changing the token expiration value, all new tokens will have the new expiration value. Already existing APIs will not be affected by the change, they will have the same expiration value as before.
Change maximum of API keys per user

This setting only affects new API keys. If a new API key makes the total number exceed the maximum number, creation is denied.

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

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

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

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

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

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

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

  2. В своем профиле в правом верхнем углу и выберите Настройки.

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

  4. Нажмите Создать новые API ключи.

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

  6. Нажмите Создать.

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

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

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