HTTP-запросы

Работа с HTTP-запросами

Это руководство поможет вам научиться создавать HTTP-запросы, редактировать их и использовать в сценариях на платформе.

1. Работа с HTTP-запросами

1.1. Просмотр списка запросов

1. Перейдите в раздел "HTTP-запросы".

2. На странице отображается список всех существующих запросов:

   • Поле поиска позволяет найти запрос по названию.

   • Фильтры помогут выбрать запросы, связанные с определёнными сценариями.

3. Чтобы создать новый запрос, нажмите кнопку "Создать HTTP-запрос".

1.2. Создание HTTP-запроса

1. После нажатия кнопки "Создать HTTP-запрос" откроется редактор. 

2. В р

   Разделе "«Основные данные":»

   Здесь задаются базовые настройки запроса.

   

   • Укажите нНазвание запроса
     Укажите понятное имя, чтобы вы могли легко распознать этот запрос в списке.
     Например: Проверка номера телефона, Получение статуса заказа, Отправка данных клиента.

   • Выберите тТип запроса
     Выберите HTTP-метод, который определяет, как запрос взаимодействует с сервером:

     • GET — используется для получения данных (например, GETсписка заказов или POST)информации о пользователе).
       В GET-запросах тело обычно не передаётся.

     • ВPOST — используетавьте URL-адреся для отправки запроса.

     • После заполнения основных данных на сервоер (напрос иможно сохеранять, но лучше не делайте этого до получения результатов, совпаздающних се настроенными принимаемыми результатами, чтвобы избежать ошибок в реальныхй звонках приси исли отправка формы).
       Тельзовании запроса обязательно.

   • URL
     Укажите полный адрес ресурса, к которому отправляется запрос.
     Пример:
     https://api.example.com/user
     или
     https://example.com/check?token={{token}}
     Если вы вставляете переменные (например, {{token}}), они будут подставлены из сценариях.

3. В разделе "Входные параметры":

   • Наи вкыполадке "Параметры" добавьте ключи и значения параметров.

   • На вкладке "Заголовки" укажите заголовки запроса.

   💡 Совет: перед сохранением убедитесь, что URL и выбранный тип запроса соответствуют API-документации внешнего сервиса.
   

   Раздел «Настройки запроса»

   Этот блок позволяет уточнить, какие именно данные передаются в запрос вместе с URL.

   Вкладка «Query-параметры»

   

   Используются для передачи данных через строку запроса (?key=value).
   Например, если вам нужно передать phone=89080450372, итоговый URL будет:
   https://example.com/check?phone=89080450372

   • Ключ — имя параметра (например, phone, user_id, token).

   • Значение — передаваемое "Тзначение (например, {{user_phone}} или конкретное число").

   ⚙️ Если вы укажиете переменную в фигурных скобках ({{переменная}}), её значение будет подставлено из сценария при выполнении запроса.

   Вкладка «Заголовки»

   

   Здесь указываются HTTP-заголовки — служебные параметры, которые помогают серверу обработать запрос.

   Типичные примеры заголовков:

   • Authorization: Bearer {{access_token}} — для передачи токена авторизации.

   • Content-Type: application/json — указывает, что тело запроса передаётся в формате JSON.

   • Ключ — название заголовка.

   • Значение — значение заголовка (может содержать переменные {{ }}).

   ---

   Вкладка «Тело запроса»

   

   Тело запроса описывает структуру данных, которые отправляются на сервер — например, в формате JSON:
   { "phone": "{{user_phone}}", "message": "Hello!" }

   💡 Совет: убедитесь, что структура тела запроса, соответствует требованиям API — исполи это POST-ьзапрос.

4. Обратиуйте внте же именани полей, что если мы передаем либо в сдокументам ключ, лцибои в значешние название в «{{}}», то этот параметр будет передаваться из самого сценария в виса.

   ---

   Разде переменной. И он отобразится в поле «Переменные во входных параметрах»
    

5. ВЭтот блок помогает увидеть, какие переменные используются внутри вашего запроса (в URL, параметрах, заголовках или теле).
   Список заполняется автоматически, когда вы добавляете значения вида {{variable_name}}.

   Пример: если вы указали {{phone}} в параметре запроса, эта переменная появится в списке.

   ---

   Раздел «Извле "Принимкаемые результаты":

   • Добавьте параметры,»

   к

   Потсле выполнения запрыеоса сервер возвращает ответ — обычно в формате JSON.
   Здесь вы указываете, какие именно данные из этого ответа нужно извлечь, чтобы использовать их дальше (в сценариях или других запросах).

• Добавление извлекаемого параметра

  • Укажите имя параметра (например, error, result, data).

  • При необходимости добавьте вложенные параметры (до 5 уровней вложенности).
    Пример пути:
    error → message → code

  • После добавления параметров нУкажмите "Сохртип даниных (сть запрос". Зкатем перейдите в раздел "Результаты", число, булево и тобы .протестировать запрос.

    ).

Эти настройки определяют, какие поля из ответа сервера будут использоваться дальше на платформе.

1.3. Работа с разделом "Результаты"

1. После настройки нажмите кнопку "Получить результаты".

2. Запрос отправится, и вы увидите статус выполнения (например, 200 OK), а также время обработки запроса.

3. Сравните возвращённые результаты с указанными принимаемыми параметрами: совпадения подсвечиваются зелёным цветом, а несоответствия красным. Вы можете редактировать или удалять принимаемые параметры в этом разделе, чтобы уточнить настройки.

1.4. Сохранение запроса

1. Сохраняйте запрос только после того, как убедитесь, что принимаемые результаты совпадают с полученными в разделе "Результаты".

2. Если результаты не совпадают, скорректируйте принимаемые параметры или настройте запрос повторно, чтобы избежать ошибок в реальных звонках.

2. Использование HTTP-запросов в сценариях

2.1. Добавление блока "Отправить HTTP-запрос"

1. Перейдите в редактор сценариев.

2. Щелкните правой кнопкой мыши по рабочему пространству и выберите "Отправить HTTP-запрос".

2.2. Настройка блока

1. Выберите ранее созданный запрос из выпадающего списка.

2. Настройте входные параметры:

   • Для каждого параметра выберите переменную сценария, которая будет передавать значение.

3. Настройте принимаемые результаты:

   • Для каждого возвращаемого значения выберите переменную, которая будет использоваться в сценарии.
     
     

     №	Действие	Скрин
     1	Нажмите ПКМ по полотну и в появившемся списке выберите блок «Отправить HTTP-запрос»
     2	В выпадающем списке выбираем наш созданный запрос
     3	После выбора запроса в разделе «Входные параметры» как раз-таки появляется параметр, который мы добавляли
     4	Присваиваем ему переменную сценария «agent_id» (как создать переменную в сценарии читай тут) Таким образом, мы передаем значение переменной из сценария в значение ключа нашего HTTP-запроса
     5	Нажимаем на вкладку «Результаты запроса» и видим, что наш запрос возвращает значение «doctor_call»  Теперь также выбираем/создаем переменную из сценария, которой мы присвоим возвращаемое http-запросом значение
     6	Сохраняем блок

2.3. Проверка и сохранение

1. Убедитесь, что все входные параметры и результаты настроены корректно.

2. Сохраните изменения сценария.

3. Советы и рекомендации

• Тестируйте запросы отдельно в редакторе запросов перед сохранением и перед добавлением в сценарий: это поможет избежать ошибок при настройке сценария.

• Следите за вложенностью: Максимальная глубина вложенности принимаемых параметров — 5 уровней.

• Используйте понятные названия переменных в редакторе сценариев: Это упростит их использование в сценариях.

Примечание

Для дополнительной информации по настройке блоков сценариев ознакомьтесь с разделом "Редактор сценариев" в документации.