API запрос

Блок «API запрос» отправляет HTTP-запрос в формате JSON на внешний сервис и получает ответ. Полученные данные можно записать в переменные и использовать их в сценарии.

Например, блок может:

отправить запрос на создание задачи в CRM;
получить в ответ id созданной задачи;
записать это значение в переменную для дальнейшего использования.

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

Добавьте на рабочую область блок «API запрос».
Установите параметр «Таймаут» — время ожидания ответа после отправки запроса.
Если ответ не получен в течение указанного времени, в результатах блока фиксируется ошибка, после чего сценарий продолжает выполнен.
Параметры таймаута:
- минимальное значение — 1 секунда;
- максимальное значение — 60 секунд.
Нажмите «Настроить запрос».

Настройка запроса

Тип и ссылка запроса

Укажите адрес сервиса в поле «Ссылка запроса».
При необходимости используйте переменные.
Выберите тип HTTP-запроса:
- GET — получение ресурса;
- POST — передача данных или создание ресурса;
- PUT — полное обновление ресурса;
- PATCH — частичное обновление ресурса;
- DELETE — удаление ресурса.

Тело запроса (Body)

Добавьте тело запроса во вкладке «Body» в формате JSON.

Пример:

{
"params": {
"chat_id": "{{id_chat}}",
"context_id": 1,
"messenger_type": "{{messenger_type}}"
}
}

Заголовки и параметры (Headers и Params)

Перейдите во вкладку «Headers» для добавления заголовков.
Перейдите во вкладку «Params» для добавления параметров запроса.
Укажите:
- название параметра в поле «Keys»;
- значение в поле «Values».

При необходимости используйте переменные.

Тестирование запроса(Testing)

Откройте вкладку «Testing».
Нажмите «Отправить тестовый запрос».

Ответ сервера в формате JSON отобразится в поле «Результат».

Если в теле запроса допущена ошибка, система отобразит сообщение: Your request body is invalid json

Для повторной отправки запроса нажмите кнопку повторной отправки.

Сохранение результатов запроса(Mapping)

Чтобы сохранить значения ответа в переменные:

Откройте вкладку «Mapping».
Можете дополнительно «Передать из тестирования».
Укажите переменные для необходимых значений.

Если значение не требуется сохранять:

оставьте поле переменной пустым;
или укажите путь вручную в формате: $.значение

Пример: $.title

Также результат запроса доступен в результате «data» блока, подробнее в статье «Результаты блоков».

Обеспечение доступности внешних сервисов

В системе реализован механизм повышения стабильности доступа к внешним ресурсам. При обращении к сайту:

сначала выполняется прямой запрос
при возникновении ошибок соединения система автоматически использует альтернативные маршруты
при успешном ответе выбранный маршрут будет использован для последующих запросов к внешнему ресурсу

Это позволяет повысить надёжность работы интеграций с внешними сервисами.

Пример сценария

Блок может понадобиться, например, для отдела продаж — бот в диалоге с клиентом запросит ИНН компании, блок «API запрос» отправит результат в сервис автоматической проверки реквизитов компании и внесет данные в карточку компании Битрикс24.