API

Раздел "API" представляет собой справочник по доступным API-методам в формате Swagger. В данном разделе представлены следующие вкладки:

  • Ключ (API Key)

  • Робот

  • Группы Роботов

  • Процесс

  • Версия Процесса

  • Работа

  • Очередь

  • Задача

  • Триггер

  • Ресурс

  • Хранилище

  • Лог

  • Аккаунт

Ключ (API Key)

В этом разделе пользователь может увидеть свой уникальный ключ доступа к API, который необходимо передать в HTTP-заголовке, в поле Ключ. Также при изменении данного поля необходимо подтвердить действие нажатием одной из кнопок:

(Assignment) - Назначить новый ключ;

(Refresh) - Обновить текущий ключ.

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

Пример:

“Bearer” — тип токена,

“Y2Y5M2U3OGUtMDk1ZC00MGNjLTkwNWUtZTYyNjUwMTg5YjU2” — сам токен, который сервер будет использовать для идентификации Пользователя.

Запросы к API осуществляются с обязательной передачей API Key, который хранится в настройках Учетной записи. Подробные примеры запросов приведены в разделе по каждому блоку отдельно.

Коды ответов:

Last updated