API#

При обновлении интеграций до версии 5.9.4 проверьте изменения API v1: часть старых маршрутов удалена, схемы запросов стали строже, а задачи теперь читаются через очередь. Для каждого запроса сверяйте метод, путь и поля со Swagger установленной версии Sherpa Orchestrator.

На экране API доступны три вкладки:

Swagger — интерактивное описание запросов, параметров и ответов. Оно также доступно по адресу https://orchestrator.sherparpa.ru/api/docs/swagger.
ReDoc — представление того же API, удобное для чтения схем и обязательных полей.
Key — таблица API-токенов. Каждый токен имеет имя, назначенные роли и срок действия; одновременно можно использовать несколько токенов.

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

Нужны права на создание API-токенов. На вкладке Key нажмите Создать, укажите имя токена и одну или несколько ролей. Задайте дату и время окончания действия либо включите Без ограничений, затем нажмите Создать. Роли определяют доступные токену действия.

После создания скопируйте значение токена или готовый заголовок Authorization из диалога. Значение показывается только один раз: сохраните его в защищённом хранилище секретов до закрытия окна. Для вызова API используйте именно заголовок, показанный Оркестратором, и сверяйте требования конкретного маршрута со Swagger. Не помещайте токен в URL, журналы или открытые файлы.

В таблице можно просмотреть срок действия и роли, изменить параметры токена или удалить ненужный токен при наличии соответствующих прав. Существующее секретное значение из таблицы повторно получить нельзя. Аутентификация Робота по GUID на предусмотренных для неё маршрутах — отдельный механизм; GUID не является API-токеном.