Использование API-токенов

Токены API используются в качестве инструмента авторизации и аутентификации пользователя PolyAnalyst.

Использование токенов должно быть предварительно включено в настройках сервера. Для этого перейдите в раздел Логин настроек сервера.
admin api tokens allow.rus

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

admin tokens create new.rus

Откроется новое окно. Сначала выберите пользователя для назначения ему API-токена.

admin tokens users.rus

Затем выберите диапазон. Под диапазоном понимаются конкретные права, которыми будет обладать пользователь при входе на сервер.

admin tokens scopes.rus

Существуют следующие диапазоны:

  • Общий (generic) – позволяет выполнять такие операции, как получение информации о пользователе и настройки пользователя, а также обновить настройки пользователя.

  • Показать проект (project_view) – получение списка проектов, информации о проекте, настроек проекта и т.д.

  • Редактировать проект (project_edit) – сохранение проекта, удаление проекта, переименование проекта, выполнение узла (узлов) в проекте и т.д.

  • Показать отчет (report_view) – получение списка отчетов, информации об отчете, списка публикаций отчета, компонентов публикации и т.д.

  • Редактировать отчет (report_edit) – переименование отчета, удаление отчета, перемещение отчета в другую папку, создание новой папки для отчетов и т.д.

  • Файл (file) – создание/удаление серверной папки или загрузка/выгрузка файлов с сервера и на сервер.

  • Планировщик задач (scheduler) – позволяет выполнять операции с планировщиком.

  • Показать состояние сервера (server_view) – получение списка настроек сервера, общей информацию о сервере, экспорт пользователей и группы пользователей.

  • Редактировать состояние сервера (server_edit) – изменение настроек сервера, перезапуск/выключение сервера, импорт пользователей и групп на сервер.

Выберите дату и время, до которых токен будет считаться действительным.

admin tokens time.rus

Вы можете использовать следующие значения даты и времени:

  • Дата/Время – устанавливает дату и время, до которых токен действителен.

  • Без ограничений – делает время действия токена неограниченным.

  • День – ограничивает срок действия токена 24 часами.

Вы также можете выбрать определенное количество дней или установить дату вручную.

При необходимости заполните поля Разрешенные IP-адреса и Разрешенные рефереры.

admin tokens fields.rus

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

В поле Разрешенные IP-адреса укажите список IP-адресов, с которых пользователь может подключиться к серверу PolyAnalyst.

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

admin tokens copy.rus