Обзор

Важно:
  • Эта функция является экспериментальной. В будущих версиях это может измениться.
  • Токены интерфейса неограниченного программирования приложений (API) могут получать доступ к функциям API, которые не имеют связанной функции.

Эта функция позволяет создавать, перечислять, обновлять и отзывать токены API. Сервер распознаёт API токены и позволяет запускать функции API. Функции API позволяют просматривать и менять данные аккаунта без необходимости входить в интерфейс cPanel. Вы можете выпустить API токены, чтобы другие могли запускать функции API с данными вашей учетной записи. Например, вы можете выпустить токен API реселлеру. Реселлер может использовать этот токен для проверки использования диска.

Примечание:

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

Чтобы создать API-токен, выполните следующие шаги:

  1. Нажмите Create. Откроется интерфейс Create API Token.
  2. Введите уникальное имя в поле API Token Name.

Примечание

  • Имя токена может содержать максимум 50 символов
  • Разрешены только:
    • буквы (a–z, A–Z)
    • цифры (0–9)
    • дефис (-)
    • нижнее подчёркивание (_)

Срок действия токена

Выберите один из вариантов в разделе Should the API Token Expire?:


  • The API Token will not expire
    → токен будет создан без срока действия

  • Specify an expiration date
    → можно задать дату окончания

По умолчанию:

  • срок действия — 1 год

После выбора появится раздел API Token Expiration Date:

  • можно выбрать дату через календарь
  • или ввести вручную в формате:
 
YYYY-MM-DD
 

Важно

Токен истечёт:

  • в выбранный день
  • в 23:59:59 по времени сервера
    • Важно:
      • Нельзя редактировать дату истечения токена API после создания.
      • Когда токен API истекает, система его не удалит. Вам нужно вручную удалить API токен.
  1. Нажмите «Создать». Появится новый интерфейс.
    • Чтобы скопировать токен API, нажмите Копировать. Думайте об этом токене как о пароле. Вы должны вводить этот токен каждый раз, когда его используете.
      Внимание:

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

  2. Нажмите «Да, я сохранил свой токен».
    • Чтобы создать новый токен, выберите «Создать другой токен» после того, как я нажму «Да, я сохранил чекбокс по токену».
    • Чтобы вернуться к интерфейсу List API Tokens, снимите опцию «Создать другой токен» после того, как я нажму «Да, я сохранил чекбокс с токеном».

Таблица токенов API

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

  • Чтобы отображать больше API токенов на странице, нажмите на значок шестерёнки (Gear), а затем выберите номер.
  • Чтобы отменить несколько токенов:
    1. Выберите галочки для каждого токена для отзыва. Выберите галочку в верхней части таблицы, чтобы выбрать каждый жетон.
    2. Нажмите «Отменить». Появится подтверждающее сообщение.
    3. Нажмите «Отменить выбранные токены API».

Таблица токенов API содержит следующую информацию:

  • Имя токена — имя токена API.
  • Создано — дата и время создания токена API.
  • Срок действия — Если токен API истекает, дата и время его истечения:
    • Когда токен API скоро истекает, интерфейс отображает строку входа жёлтым. Также отображается иконка уведомления (Ծանուցում).
    • Интерфейс отображает истекшие строки ввода токена API красным цветом. Также отображается иконка уведомления (Ծանուցում).
      Помните:

      Когда токены API истекают, система их не удаляет. Вы должны вручную удалить просроченные токены API.

  • Управление — нажмите «Управлять», чтобы открыть новый интерфейс и выполнить следующие действия:
    • Переименование токена — Присвоите новое имя токена.
    • Отменить токен — удалить токен и запретить ему доступ к серверу или функциям API.

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

Чтобы управлять токеном API, найдите его в таблице API Tokens и нажмите Manage. Появится интерфейс Manage API Token.

Переименование токена

Чтобы назначить новое имя токена, введите новое имя в текстовое поле New API Token Name. Затем нажмите «Обновить».

Отменить жетон

Внимание:

Если вы отмените API токен, пользователи не смогут запускать скрипты или функции API с этим токеном.

Для отзыва токена API:

  1. Нажмите «Отменить». Появится подтверждающее сообщение.
  2. Нажмите «Да, отменить токен», чтобы отменить токен.
Примечание:

Чтобы удалить токен API в командной строке, используйте функцию UAPI Tokens::revoke.

Помог ли вам данный ответ? 0 Пользователи нашли это полезным (0 голосов)