Веб-запрос - БЕТА

Этап этап веб-запроса может применяться для получения информации для использования в боте или внесения изменений во внешнюю систему. Этап запускается из платформы Ivanti Neurons и выполняется один раз для каждого задействованного на этапе устройства. Он может взаимодействовать с интерфейсами REST API сторонних компаний и поддерживается в API с аутентификацией и без нее.

Конфигурация этапа веб-запроса

1. На странице создания бота добавьте этап Веб-запрос в бот и откройте раздел Настройки этапа.
2. В раскрывающемся списке Выбор учетных данных выберите учетные данные, если веб-запрос будет требовать аутентификацию. Если нужно создать новые учетные данные, нажмите Добавить учетные данные для открытия хранилища учетных данных. В настоящее время поддерживается базовый интерфейс API и аутентификация по ключу API. Если учетные данные не требуются, оставьте настройку по умолчанию Нет аутентификации.
3. В разделе Заголовки установите для параметра Показывать автосозданные заголовки значение Вкл, если нужно отображать автосозданные заголовки. Заголовки должны соответствовать требованиям целевого API-интерфейса - для получения дополнительной информации см. документацию стороннего производителя.
   • Ключ: Введите ключ раздела для веб-запроса.
   • Значение: Введите значение заголовка для веб-запроса.
4. Выберите Метод. Это метод HTTP, который будет использоваться для доступа к целевому API. Поддерживаемые методы: GET, POST, PUT, PATCH и DELETE.
5. Введите Адрес для API. Адрес должен быть доступен из Интернета.
   Если значения пересылаются из другого этапа или вводных данных бота, а целевой API принимает данные в формате JSON, нажмите Редактировать текст JSON для открытия редактора Json. Выберите значения, которые нужно добавить (этап веб-запроса должен быть связан с любыми предыдущими этапами для передачи информации).
   
6. Выберите соответствующий режим вывода для обработки ответа API. Если выбран HTTP-метод GET, наиболее распространенным будет JSON.
7. Нажмите Тестировать и получить ответ для немедленного вызова API.
   Если текст JSON содержит переменные из более ранних этапов, будет предложено ввести данные примера.
8. Значение Пример ответа заполняется из теста и получает ответное действие.
   После проверки ответа можно определить, являются ли результаты единичными (уникальные поля для каждой конечной системы) или массивом (несколько значений данного поля для каждой конечной системы).
9. Если результаты представляют собой массив, необходимо включить параметр Массив назначения.
   Когда этап находится в режиме массива назначения, он будет отображать значок "несколько" - для использования результатов на большинстве других этапов потребуется использовать блок "для каждого" для обработки данных каждого результата.
   • Введите Путь массива.
10. После назначения параметру Массив назначения значения Вкл заполните следующие атрибуты Назначение полей:
    • Путь внутри элемента массива: Путь к объекту в ответе JSON. Это может быть просто имя или, если объект является вложенным, путь должен иметь синтаксис с точками разделителями, например, level1.level2.myfield
      Пример единичного использования:
      {"конфигурация": {startup_events": {"обновления": "значение"}}}
      Путь к обновлениям: configuration.startup_events.updates
      Пример массива:
      {"пользователи": [{display_info": {"имя": "Валерий"}}]}
      Путь массива: users
      Путь внутри массива: display_info.name
    • Тип: Должен соответствовать формату считываемого значения для применения на следующих этапах корректных фильтров/действий.
    • Назначенная метка: Это понятное имя поля, которое будет отображаться в средстве выбора маркеров и фильтрах на следующих этапах.

После выбора атрибутов назначения массива нажмите Тест назначения для проверки назначения для примера ответа -это позволит проверить назначения.