Личный кабинет
API-токены. Получить перманентный токен, использовать и удалить
API-токен — это специальный код с определённым сроком действия, который позволяет вашему приложению получить доступ к аккаунту через API.
Для чего нужен перманентный API-токен
Если вы хотите настроить автоматизированный процесс работы с нашими сервисами (например, автоматическую очистку кеша на CDN), используйте перманентный API-токен, создать который можно в личном кабинете.
Важно. Пожалуйста, обратитесь к API-документации продукта, чтобы проверить, поддерживает ли он перманентные API-токены.
Используйте заголовок APIKey перед сгенерированным токеном, например:
Authorization: APIKey 7711$eyJ0eXAiOiJKVРаздел API-токены
В этом разделе отображаются все выпущенные API-токены, а также информация о том, кто выпустил токен, какая роль ему присвоена, когда токен был использован, срок его действия и статус.
Важно. Только пользователи с ролью Administrators могут видеть и управлять всеми токенами, выпущенными для аккаунта. Пользователи с другими ролями видят и могут управлять только теми токенами, которые были выпущены этими пользователями.
Для быстрого поиска токена можно воспользоваться фильтрацией по:
-
пользователю, который выпустил токен — фильтр «Издатель»,
-
роли, присвоенной токену — фильтр «Роли»,
-
статусу токена: Активный/Истёк/Удалён — фильтр «Статус».
Как создать перманентный API-токен
Для одного аккаунта может быть выпущено не более 50 перманентных токенов. Для того, чтобы создать перманентный API-токен:
1. Нажмите на иконку профиля в левом нижнем углу страницы.
2. Перейдите в Настройки аккаунта.
3. Откройте раздел API-токены.
4. Нажмите Создать токен.
Откроется форма создания API-токена.
5. В поле «Имя» укажите название создаваемого токена.
6. В поле «Описание» можно внести дополнительные сведения о токене. Это необязательное поле.
7. В разделе Роль укажите права, которые присваиваются создаваемому токену.
Важно. Пользователь может создать токен с ролью равной своей или ниже. Это значит, что пользователь с ролью User не может создать токен с ролью Administrator.
8. В разделе Срок действия выберите срок действия токена:
-
«Бессрочный» — срок действия токена неограничен.
-
«Задать срок действия» — при выборе этого пункта обязательно задайте срок истечения срока действия токена в поле ниже.
9. После заполнения всех обязательных полей кнопка Создать станет активной. Нажмите её для генерации API-токена.
Откроется окно с API-токеном.
Важно. Сгенерированный токен не хранится в системе. Просмотреть его в личном кабинете можно только один раз во время его создания. Скопируйте и сохраните токен.
10. После того как вы сохранили сгенерированный токен нажмите Ок, токен скопирован. Информация о токене будет отображена в разделе API-токены.
Как удалить API-токен
Только пользователи с ролью Administrator могут удалять любые токены, выпущенные для аккаунта. Пользователи с другими ролями могут удалять только те токены, которые были выпущены этими пользователями. Для того, чтобы удалить API-токен:
1. Нажмите на иконку профиля в левом нижнем углу страницы.
2. Перейдите в Настройки аккаунта.
3. Откройте раздел API-токены.
4. Откройте меню напротив необходимого API-токена и выберите Удалить API-токен.
Уведомления об истечении срока действия API-токенов
Уведомления об истечении срока действия API-токенов отображаются в личном кабинете и по умолчанию пересылаются на почту пользователям, которые выписали токен и пользователям с ролью Administrator. Для того, чтобы настроить уведомления:
1. Нажмите на иконку профиля в левом нижнем углу страницы.
2. Перейдите в Настройки пользователя.
3. Откройте раздел Уведомления и включите уведомления о токенах.
Пользователи уведомляются по почте:
-
за 7 дней до истечения токена,
-
за 1 день до истечения токена.
Раздел API-токены будет отмечен восклицательным знаком, если в аккаунте есть токены, которые истекают через 7 или менее дней.
В разделе API-токены напротив токенов, нуждающихся во внимании, будут стоять специальные символы:
-
если токен истекает через 7 или менее дней,
-
если токен уже истёк,
-
если токен удалён.
Особенности работы API-токена и SSO
При авторизации через SAML SSO наша система не располагает информацией о статусе разрешений, выданных пользователю провайдером.
Даже если провайдер отозвал у пользователя права доступа, его токены останутся активными для доступа к управлению аккаунтом.
Важно. Если вам необходимо ограничить доступ по перманентному API-токену для пользователя с авторизацией через SSO, удалите соответствующий токен из Личного кабинета.