Личный кабинет: API токены

Примечание

В конфигурации по умолчанию этот раздел личного кабинета доступен только пользователям групп Technical и Administrative.

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

Посмотреть список токенов

В разделе API токены личного кабинета отображается таблица со всеми действующими токенами для текущего аккаунта.

Доступны следующие столбцы:

  • Токен — строка, которую следует передавать в HTTP-заголовке для авторизации в Qrator API.

    Строка отображается в сокращённом виде. Кликните по ней, чтобы скопировать полную строку токена в буфер обмена.

  • Комментарий — комментарий к токену, который был введён при его добавлении или редактировании. Может быть пустым.

  • Политики — количество политик, добавленных для токена.

    Иногда это число соответствует количеству методов API, которые могут быть вызваны с этим токеном, но в некоторых случах реальное количество методов может быть больше (при использовании политик Любой клиентский метод или Любой ресурсный метод).

Добавить токен

  1. В разделе API токены личного кабинета нажмите кнопку Добавить токен API. Откроется диалог добавления токена.

  2. Введите Комментарий для токена. Это поле можно оставить пустым.

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

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

    Чтобы добавить политику, связанную с методами из раздела Client methods документации Qrator API:

    1. Нажмите Добавить политику. Откроется диалог добавления политики.
    2. В выпадающем списке выберите название клиентского метода или политику Любой клиентский метод.
    3. Нажмите Сохранить.

    Чтобы добавить политику, связанную с методами из разделов Domain methods и Service methods документации Qrator API:

    1. Нажмите Добавить политику. Откроется диалог добавления политики.
    2. В выпадающем списке выберите название ресурсного метода или политику Любой ресурсный метод.
    3. Выберите один или несколько ресурсов (доменов или сервисов), для которых должна действовать политика, или отметьте чекбокс Любой ресурс.
    4. Нажмите Сохранить.

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

  4. Нажмите кнопку Добавить, чтобы завершить добавление токена.

    Добавленный токен можно скопировать, кликнув по значению в первом столбце.

Редактировать токен

  1. В разделе API токены личного кабинета нажмите напротив токена, который вы хотите отредактировать.

  2. Если необходимо, измените Комментарий для токена.

  3. Если необходимо, измените список политик для токена.

    Чтобы добавить политику, связанную с методами из раздела Client methods документации Qrator API:

    1. Нажмите Добавить политику. Откроется диалог добавления политики.
    2. В выпадающем списке выберите название клиентского метода или политику Любой клиентский метод.
    3. Нажмите Сохранить.

    Чтобы добавить политику, связанную с методами из разделов Domain methods и Service methods документации Qrator API:

    1. Нажмите Добавить политику. Откроется диалог добавления политики.
    2. В выпадающем списке выберите название ресурсного метода или политику Любой ресурсный метод.
    3. Выберите один или несколько ресурсов (доменов или сервисов), для которых должна действовать политика, или отметьте чекбокс Любой ресурс.
    4. Нажмите Сохранить.

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

  4. Нажмите Редактировать, чтобы сохранить изменения и закрыть диалог.

Удалить токен

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

  2. Подтвердите действие, нажав Удалить в появившемся диалоге.

expand_less