Введение
В этой статье мы рассмотрим механизм формирования API-запроса и передачи данных через него.
Предварительные условия
Перед работой с API-запросами важно убедиться, что:
- Алгоритм опубликован в Orchestrator SaaS. Подробнее о публикации алгоритмов можно узнать здесь.
- Orchestrator SaaS имеет хотя бы один подключенный Bot Runner. Подробнее о подключении Bot Runner к Orchestrator можно узнать здесь.
- Как минимум один активный Bot Runner назначен на алгоритм. Подробнее о назначении Bot Runner на алгоритмы можно узнать здесь.
Отправка API-запроса и передача данных через него
Отправку API-запроса можно протестировать с использованием любого удобного для вас инструмента. Ниже мы рассмотрим пример тестирования через популярный инструмент Postman, который, помимо прочего, позволяет формировать код запроса на нужном вам языке программирования.
Формирование API-запроса
Чтобы сформировать API-запрос:
- Перейдите на портал API документации ElectroNeek.
- Выберите соответствующий вашей организации
endpoint
.
Если перейти в документацию API через пользовательский портал (Orchestrator SaaS → Integrations → API → «Documentation»), тоendpoint
будет выбран автоматически в соответствии с регионом организации, под которой вы авторизованы на портале. - Для передачи данных через API-запрос нам нужно, чтобы API-запрос запускал выполнение алгоритма. Для этого будем использовать метод
POST /workflow/{id}/launch
. - Строка API-запроса формируется следующим образом:
{{endpoint}}/workflow/{id}/launch
, где:{{endpoint}}
—https://api.cis.electroneek.com/v1/orchestrator
(в случае с организацией в регионе CIS){id}
—id
запускаемого алгоритма. Чтобы его узнать:- Перейдите на портал electroneek.com → Orchestrator SaaS → «Workflows»
- В списке опубликованных алгоритмов найдите нужный вам и нажмите на строку с его названием, чтобы открыть подробную информацию.
- Справа от названия алгоритма будет кнопка «Copy ID». Нажмите на нее — id алгоритма будет скопирован в буфер обмена.
- Таким образом, URL API-запроса должен выглядеть так:
https://api.cis.electroneek.com/v1/orchestrator/workflow/61f3a4afc450b2375397f562/launch
- Перейдите в Postman. Выберите метод
POST
и вставьте в строку запроса вставьте URL API-запроса. - В разделе «Headers» создайте новый Header, где:
- Key -
Authorization
. - Value -
Api-Key {{токен API}}
, например:Api-Key B10uX4CJnsg9hoGhlsdsGbyeRKyAGkqF
. О создании токена API можно узнать из этой статьи.
- Key -
- Нажмите «Send». Если все заполнено корректно, то API-запрос запустит бота. В качестве результата вернется такое значение (где
launch_id
будет соответствовать id запущенного алгоритма):
{
"launch_id": "62692aedaff0c8dd8ad8ab41"
}
Передача данных через API-запрос
Чтобы передать данные через API-запрос:
- Перейдите в раздел «Body» в Postman.
- В параметре
payload
между фигурными скобками можно прописать данные, которые необходимо передать в Studio Pro.
Обратите внимание: данные, записываемые вpayload
должны быть в формате JSON. - Данные, переданные через
payload
, принимаются в Studio Pro в переменнуюwebhook_data
.
Рассмотрим пример передачи данных в бота:
- Запишем в параметр
payload
сообщение, которое будет выводиться в уведомлении пользователю:
"payload": {
"notification": "Success!"
} - Создадим простого бота, состоящего из единственного действия — Уведомление пользователя.
- В параметре «Сообщение пользователю» выберем опцию «Вычислить значение» и запишем переменную
webhook_data
и параметр, значение которого нужно считать:webhook_data.notification
- Запустим бота через API-запрос.
- Если все сделано верно — в результате будет показано уведомление с сообщением «Success!».