Действие позволяет выполнить запрос на любой адрес, выбрав метод, параметры, заголовки и авторизацию запроса.
Важно: На данный момент, для предотвращения злоупотреблений, доступны только запросы на сайты популярных открытых API (при стуке на неразрешенный адрес - выскакивает ошибка; список открытых api мы не раскрываем). Если нужный Вам сайт отсутствует в списке - напишите в поддержку IT-Solution, и мы добавим его.
При использовании вебхука запрос на сторонний сервер происходит от лица приложения Rest Активити - с IP адреса 94.26.246.180 (домен restactivity.it-solution.ru).
С чего начать
Для использования REST Активити необходимо настроить параметры запроса, указанные ниже.
Поля активити блока
| Название поля | Картинка | Что значит | Пример заполнения |
|---|---|---|---|
| HTTP-метод | Указание на операцию, которую клиент запрашивает выполнить на сервере с указанным ресурсом. Варианты операций: - GET: получить данные - POST: отправить ресурс - PUT: создать или заменить ресурс - PATCH: внесения частичных изменений в существующий ресурс - DELETE: удаление ресурса |
POST | |
| Формат отправки данных | В каком виде сервер ожидает получить данные: - FormData: специальная коллекция данных, которая позволяет передавать данные в виде пар [ключ, значение]. - application/json: структурированная информация, представленная в текстовом формате JSON (JavaScript Object Notation) - Отправить как есть: отправить данные без какого-либо изменения, кодирования или преобразования. Формат данных здесь зависит от того какой синтаксис ожидает сервер. |
- FormData: key1: value1- application/json: {- Отправить как есть: key1,value1
|
|
| Данные | Данные для POST/PUT/PATCH запроса. При GET-запросе всегда игнорируются, параметры для DELETE-запроса могут быть проигнорированы или обрезаны сервером. | Зависит от выбранного формата отправки данных | |
| HTTP-авторизация | Basic HTTP-авторизация в формате username:password | username:password | |
| Заголовки запроса | Дополнительные заголовки HTTP-запроса | User-Agent: ITSolution-bitrix24/1.0 X-Example-Header: Some value |
|
| JSONPath | JSONPath — это язык запросов для извлечения данных из JSON-документов. Jsonpath селектор будет использован только если сервер вернет ответ в формате json. Если добавить несколько jsonpath то к ним можно обратится по отдельности в Доп.-Результатах в шаблоне Бизнес-Процесса |
$.form.key1 | |
| Пользователь для отладки | Данный пользователь будет получать отладочные уведомления | Иван Иванов[1] |
Использование результатов работы активити
Использовать результаты работы активити блока можно через вкладку Доп.результаты.
- Результат - Все результаты jsonpath
- Ошибки выполнения запроса
- time_execute - Время выполнения запроса
- Статус ответа
- Результат только для X jsonpath - Результат только с определенного jsonpath если их несколько
- Таймаут операции - Время выполнения операции превысило время ожидания