API-токены. Как получить перманентный токен, использовать и удалить

API-токен — это специальный код с определенным сроком действия, который позволяет вашему приложению получить доступ к аккаунту через API.

Для чего нужен перманентный API-токен?

В API-документации описано получение стандартного токена авторизации со сроком действия 1 час, для его обновления используется запрос «Refresh token», срок действия этого токена - 24 часа. Такие сроки действия хорошо подходят для разовых запросов.

Если вы хотите настроить автоматизированный процесс работы с нашим CDN сервисом (например, автоматическая очистка кеша), используйте перманентный API-токен, создать который можно в личном кабинете.

На данный момент перманентный API-токен может быть применен только к запросам, относящимся к сервисам «Облако», «CDN» и «Хранилище» .

Используйте заголовок «APIKey» перед сгенерированным токеном, например: 'Authorization: APIKey 7711$eyJ0eXAiOiJKV'. 

Как создать перманентный API-токен?

Для одного аккаунта может быть выпущено не более 50 перманентных токенов.

  1. В Личном кабинете перейдите в «Профиль».
  2. Откройте раздел «API-токены».
  3. Нажмите «Создать API-токен».

    ______________________.png
  4. Откроется форма создания API-токена.

    ____________.png
  5. В поле «Имя» укажите название создаваемого токена.
  6. В поле «Описание» можно внести дополнительные сведения о токене. Это необязательное поле.
  7. В разделе «Роль» укажите права, которые присваиваются создаваемому токену.

Важно! Пользователь может создать токен с ролью равной своей или ниже. Это значит, что пользователь с ролью «User» не может создать токен с ролью «Administrators».

  1. В разделе «Срок действия» выберите срок действия токена:
  • «Бессрочный» - срок действия токена неограничен.
  • «Задать срок действия» - при выборе этого пункта обязательно задайте срок истечения срока действия токена в поле ниже.

    _____________.png                        
  1. После заполнения всех обязательных полей кнопка «Создать» станет активной. Нажмите ее для генерации API-токена.
  2. Откроется окно с API-токеном.

    _________________.png

Важно! Сгенерированный токен не хранится в системе. Просмотреть его в Личном кабинете можно только один раз во время его создания. Скопируйте и сохраните токен.

  1. После того как вы сохранили сгенерированный токен нажмите «Ок, токен скопирован». Информация о токене будет отображена в разделе «API-токены».

Как удалить API-токен

Только пользователи с ролью «Administartors» могут удалять любые токены, выпущенными для аккаунта. Пользователи с другими ролями могут удалять только те токены, которые были выпущены только этими пользователями.

  1. В Личном кабинете перейдите в «Профиль».
  2. Откройте раздел «API-токены».
  3. Напротив необходимого API-токена нажмите на знак трех точек и выберите «Удалить API-токен».

    _________________.png

Раздел API-токены

В этом разделе отображаются все выпущенные API-токены, а также информация о том, кто выпустил токен, какая роль ему присвоена, когда токен был использован, срок его действия и статус.

Важно! Только пользователи с ролью «Administrators» могут видеть и управлять всеми токенами, выпущенными для аккаунта. Пользователи с другими ролями видят и могут управлять только теми токенами, которые были выпущены этими пользователями.

Для быстрого поиска токена можно воспользоваться фильтрацией по:

  • Пользователю, который выпустил токен - фильтр «Издатель».
  • Роли, присвоенной токену - фильтр «Роли».
  • Статусу токена: активный/истек/удален - фильтр «Статус».

    _________.png

Уведомления об истечении срока действия API-токенов

Уведомления об истечении срока действия API-токенов отображаются в личном кабинете и по умолчанию пересылаются на почту пользователям, которые выписали токен и пользователям с ролью «Administrators».

Настроить уведомления можно в разделе «Уведомления» вкладки «Профиль».

__________________.png

Пользователи уведомляются по почте:

  • За 7 дней до истечения токена.
  • За 1 день до истечения токена.

Раздел «API-токены» будет отмечен восклицательным знаком, если в аккаунте есть токены, которые истекают через 7 или менее дней.

____________________.png

В разделе «API-токены» напротив токенов, нуждающихся во внимании, будут стоять специальные символы: 

  • Если токен истекает через 7 или менее дней.

    _________________2____.png
  • Если токен уже истёк.

    _____.png
  • Если токен удален.

    ______.png

Особенности работы API-токена и SSO 

При авторизации через SAML SSO наша система не располагает информацией о статусе разрешений, выданных пользователю провайдером.

Даже если провайдер отозвал у пользователя права доступа, его токены останутся активными для доступа к управлению аккаунтом.

Важно! Если вам необходимо ограничить доступ по перманентному API-токену для пользователя с авторизацией через SSO, удалите соответствующий токен из Личного кабинета.

 

Была ли статья полезна?
Недавно просмотренные статьи