API#

Раздел API предназначен для просмотра документации по подключению к серверному ПО через API, а также для генерации токенов.

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

1. Документация в формате Swagger#

Во вкладке Swagger можно ознакомиться с инструкцией по работе с API в формате Swagger.

Информация разделена на блоки на каждый раздел системы Sherpa Process Discovery.

2. Документация в формате ReDoc#

Во вкладке ReDoc можно ознакомиться с инструкцией по работе с API в формате ReDoc.

Информация также разделена на блоки на каждый раздел системы Sherpa Process Discovery.

3. Токен#

Во вкладке Токен можно ознакомиться с перечнем API-токенов, созданных в системе.

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

Создать токен#

После нажатия на кнопку Создать токен открывается окно "Создать токен".

В нем необходимо указать название токена, выбрать роль, определяющую доступные действия, и задать срок действия токена. При необходимости можно установить флажок Бессрочно. Для завершения создания нажмите Создать токен, для закрытия окна без сохранения — Отмена.