Введение

В этой статье мы рассмотрим механизм формирования API-запроса и передачи данных через него. 

Предварительные условия

Перед работой с API-запросами важно убедиться, что:

1. Алгоритм опубликован в Orchestrator SaaS. Подробнее о публикации алгоритмов можно узнать здесь.
2. Orchestrator SaaS имеет хотя бы один подключенный Bot Runner. Подробнее о подключении Bot Runner к Orchestrator можно узнать здесь. 
3. Как минимум один активный Bot Runner назначен на алгоритм. Подробнее о назначении Bot Runner на алгоритмы можно узнать здесь.  
   

Отправка API-запроса и передача данных через него

Отправку API-запроса можно протестировать с использованием любого удобного для вас инструмента. Ниже мы рассмотрим пример тестирования через популярный инструмент Postman, который, помимо прочего, позволяет формировать код запроса на нужном вам языке программирования. 

Формирование API-запроса

Чтобы сформировать API-запрос:

1. Перейдите на портал API документации ElectroNeek.
2. Выберите соответствующий вашей организации endpoint. 
   
   
   Если перейти в документацию API через пользовательский портал (Orchestrator SaaS → Integrations → API → «Documentation»), то endpoint будет выбран автоматически в соответствии с регионом организации, под которой вы авторизованы на портале. 
   
   
3. Для передачи данных через API-запрос нам нужно, чтобы API-запрос запускал выполнение алгоритма. Для этого будем использовать метод
   POST /workflow/{id}/launch.
   
   
   
   
4. Строка API-запроса формируется следующим образом:
   {{endpoint}}/workflow/{id}/launch, где:
   
   {{endpoint}} — https://api.cis.electroneek.com/v1/orchestrator (в случае с организацией в регионе CIS)
   
   {id} — id запускаемого алгоритма. Чтобы его узнать:
   1. Перейдите на портал electroneek.com → Orchestrator SaaS → «Workflows»
   2. В списке опубликованных алгоритмов найдите нужный вам и нажмите на строку с его названием, чтобы открыть подробную информацию. 
   3. Справа от названия алгоритма будет кнопка «Copy ID». Нажмите на нее — id алгоритма будет скопирован в буфер обмена. 
      
5. Таким образом, URL API-запроса должен выглядеть так:
   https://api.cis.electroneek.com/v1/orchestrator/workflow/61f3a4afc450b2375397f562/launch
6. Перейдите в Postman. Выберите метод POST и вставьте в строку запроса вставьте URL API-запроса. 
   
   
   
7. В разделе «Headers» создайте новый Header, где:
   1. Key - Authorization.
   2. Value - Api-Key {{токен API}}, например: Api-Key B10uX4CJnsg9hoGhlsdsGbyeRKyAGkqF. О создании токена API можно узнать из этой статьи. 
      
      
      
8. Нажмите «Send». Если все заполнено корректно, то API-запрос запустит бота. В качестве результата вернется такое значение (где launch_id будет соответствовать id запущенного алгоритма):
   

   {
       "launch_id": "62692aedaff0c8dd8ad8ab41"
   }

Передача данных через API-запрос

Чтобы передать данные через API-запрос:

1. Перейдите в раздел «Body» в Postman.
   
   
   
2. В параметре payload между фигурными скобками можно прописать данные, которые необходимо передать в Studio Pro. 
   
   Обратите внимание: данные, записываемые в payload должны быть в формате JSON.
3. Данные, переданные через payload, принимаются в Studio Pro в переменную webhook_data.

Рассмотрим пример передачи данных в бота:

1. Запишем в параметр payload сообщение, которое будет выводиться в уведомлении пользователю:
   

    "payload": {
           "notification": "Success!"
    }

   
   
   

2. Создадим простого бота, состоящего из единственного действия — Уведомление пользователя. 
3. В параметре «Сообщение пользователю» выберем опцию «Вычислить значение» и запишем переменную webhook_data и параметр, значение которого нужно считать:
   webhook_data.notification
   
   
4. Запустим бота через API-запрос.
5.  Если все сделано верно — в результате будет показано уведомление с сообщением «Success!».