Перейти к содержанию

Управление API-токенами

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

Что такое API-токен

Токен — это секретный ключ доступа. Внешняя система предъявляет его при каждом обращении к API, и приложение определяет, какие данные ей доступны.

Токен привязан к пользователю и даёт внешней системе те же права доступа, что и этому пользователю. Например, если токен создан для пользователя с правом просмотра оборудования, внешняя система сможет получать сведения об оборудовании, но не сможет изменять другие данные.

Примечание

На одного пользователя может быть создан только один токен.

Токен отображается на экране один раз — при создании. Увидеть его повторно невозможно, поэтому сразу скопируйте его и храните в надёжном месте.

Предварительные условия

Чтобы создавать и удалять API-токены, нужны права администратора.

Создание API-токена

Инструкция:

  1. В главном меню откройте раздел / Обслуживание / API-токены /.
  2. Нажмите кнопку Создать.

  3. Заполните форму:

  4. Имя токена — понятное название, по которому вы отличаете токены друг от друга.

  5. Комментарий — необязательное пояснение, например о том, какой системе выдан токен.
  6. Дата окончания срока действия — дата, после которой токен перестанет работать. Оставьте поле пустым, если срок действия токена не ограничен.
  7. Пользователь — пользователь, права которого получит внешняя система.
  8. Нажмите кнопку Создать.

Результат: откроется окно «Скопируйте токен» с текстом токена.

Копирование и хранение токена

Опасно

Токен отображается только один раз. После обновления страницы его нельзя получить повторно.

  1. В окне «Скопируйте токен» нажмите кнопку Копировать в буфер обмена. Кнопка сменит надпись на Скопировано.
  2. Вставьте токен в надёжное хранилище, например в менеджер паролей.
  3. Закройте окно.

Совет

Создайте токен до настройки внешней системы, чтобы успеть сохранить его текст.

Просмотр прав доступа токена

Чтобы проверить, какие права получит внешняя система:

  1. Откройте раздел / Обслуживание / API-токены /.
  2. В колонке Права доступа нажмите на значок сведений рядом с нужным токеном.
  3. В открывшемся окне «Права доступа» ознакомьтесь со списком прав.

Результат: окно «Права доступа» показывает полный список прав пользователя, закреплённых за токеном.

Примечание

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

Удаление API-токена

Удалённый токен перестаёт действовать — внешняя система больше не сможет обращаться к API.

Удаление одного токена: 1. Откройте раздел / Обслуживание / API-токены /. 2. В строке нужного токена нажмите значок Удалить. 3. Подтвердите действие.

Удаление всех токенов: 1. Откройте раздел / Обслуживание / API-токены /. 2. Нажмите кнопку Удалить все. 3. Подтвердите действие.

Предупреждение

После удаления все внешние системы потеряют доступ. Если доступ всё ещё нужен, создайте токены заново и передайте их администраторам систем.

Рекомендации по безопасности

  • Храните токены в менеджере паролей и не передавайте их по электронной почте.
  • Создавайте токен под каждого пользователя, чьи права нужны внешней системе.
  • Устанавливайте дату окончания срока действия, чтобы ограничить время доступа.
  • Удаляйте токены, которые больше не используются.
  • Удалите скомпрометированный токен и создайте новый.

Устранение неполадок

Проблема: вы закрыли окно «Скопируйте токен» и не сохранили текст токена.
Решение: токен нельзя показать повторно. Удалите токен и создайте новый, затем сразу сохраните его текст.

Проблема: внешняя система перестала получать доступ, хотя токен ещё действует.
Решение: проверьте дату окончания срока действия токена. Если срок истёк, создайте токен заново и передайте его администратору системы.

Проблема: токен скомпрометирован.
Решение: удалите токен и создайте новый в разделе / Обслуживание / API-токены /.