Внешние запросы

Каталог «Внешние запросы» позволяет Бипиуму принимать входящие веб-запросы от внешних систем. Каждая запись — это отдельный адрес-слушатель, при обращении на который Бипиум запускает указанный сценари

Каталог «Внешние запросы» позволяет Бипиуму принимать входящие веб-запросы от внешних систем. Каждая запись — это отдельный адрес-слушатель, при обращении на который Бипиум запускает указанный сценари

Каталог Внешние запросы

Как это работает

Внешняя система отправляет HTTP-запрос на адрес слушателя в Бипиуме. Бипиум принимает запрос, передает входные данные в сценарий и запускает его. Сценарий обрабатывает данные и возвращает результат внешней системе в качестве ответа на запрос.

Типичные сценарии использования: приём заявок с сайта, получение данных от сторонних сервисов, интеграция с CRM или телефонией.

Свойства полей записи

Поле

Описание

Статус

Активно — слушатель принимает запросы.

Выключено — запросы на адрес не принимаются.

Название

Обязательное поле. Произвольное название для идентификации слушателя в каталоге.

Описание

Вспомогательный комментарий — для чего используется этот слушатель.

Секция Параметры запроса

Поле

Описание

URL-идентификатор

Уникальная часть адреса слушателя. Допустимы латинские буквы, цифры, дефис и знак подчеркивания. Используется для формирования полного адреса.

Выполнить

Сценарий, который будет запущен при поступлении запроса на этот адрес.

Адрес слушателя

Полный адрес, на который внешняя система должна отправлять запросы, формируется по правилу:

[Домен]/api/webrequest/[URL-идентификатор]

Например, если домен компании company.bpium.ru, а URL-идентификатор — new-order, то полный адрес будет:

https://company.bpium.ru/api/webrequest/new-order

Подробнее о формате входных и выходных данных, которые передаются в сценарий и возвращаются в ответе, читайте в разделе Автоматизации → Внешние запросы.

Как создать слушателя

  1. Перейдите в «Управление → Внешние запросы» и создайте новую запись.

  2. Введите название и задайте URL-идентификатор — он должен быть уникальным.

  3. В поле «Выполнить» выберите сценарий, который будет обрабатывать входящие запросы.

  4. Убедитесь что статус установлен в «Активно», и сохраните запись.

  5. Передайте полный адрес слушателя во внешнюю систему.