...

Send request Version 15 (Java)

Группа действийAction group: ИнтеграцииIntegrations

Описание

Действие отправляет HTTP-запрос для обращения к RESTful веб-сервису

Иконка действия

Image Removed

Параметры

Входные параметры

1. URL REST-сервиса - URL REST-сервиса

2. Метод - Определяет тип создаваемого запроса. По умолчанию Get.

3. Тело запроса - Тело отправляемого запроса. Позволяет отправить запрос в виде JSON строки.

4. Параметры запроса - Параметры строки запроса

5. Параметры формы - Параметры HTML формы для метода POST.

6. Авторизация - Словарь с параметрами авторизации - Basic или Bearer Token. В случае Basic авторизации словарь должен иметь ключи «user» и «pass», а значения элементов словаря должны содержать логин и пароль пользователя. В случае Bearer Token авторизации словарь должен иметь ключ «token», а значение элемента должно содержать Bearer Token.

7. Заголовки запроса - Набор заголовков отправляемого запроса и их значений. Каждый ключ – отдельный заголовок.

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

9. Выбор прокси-сервера - Определяет настройки используемого прокси-сервера. Можно использовать системные настройки прокси, заданные на уровне ОС, либо настроить параметры пользовательского прокси-сервера, либо подключаться без прокси-сервера. По умолчанию используются системные настройки.

10. Протокол прокси- сервера - Протокол прокси-сервера. Например: http, https

11. Имя хоста или IP-адрес прокси-сервера - Имя хоста или IP-адрес прокси-сервера

12. Порт прокси-сервера - Порт прокси-сервера

13. Логин пользователя для подключения к прокси- серверу - Логин пользователя для подключения к прокси-серверу

14. Пароль пользователя для подключения к прокси-серверу - Пароль пользователя для подключения к прокси-серверу

15. Получить файл - Возможность получить файлы из запроса. Если выбрано значение «true», обязательно должны быть заполнены поля «Путь до папки» и «Имя файла».

16. Путь до папки - Путь к папке, в которой нужно сохранить полученный файл.

17. Имя файла - Поле для имени файла с расширением.

18. Перезаписать - Перезаписать существующий файл. В случае, если значение параметра false, а в указанной папке уже существует файл с таким же именем и расширением, то будет вызвана ошибка. Значение по умолчанию - false.

19. Отключить SSL - Отключить SSL. Если значение true, то отключается опция проверки SSL-сертификата. По умолчанию значение false.

Выходные параметры

1. Статус ответа - Числовая переменная, в которую запишется код статуса ответа веб-сервиса. Возвращается всеми методами.

2. Заголовки ответа - Набор заголовков, получаемых от сервера, и их значения. Возвращается всеми методами. Если в ответе от сервера встречаются повторяющиеся заголовки, их значения собираются в отдельную коллекцию, которая сохраняется в словаре с заголовком в качестве ключа.

3. Тело ответа - Строковая переменная, в которую запишется тело ответа веб-сервиса в raw формате. Возвращается всеми методами

4. Идентификатор - Строковая переменная, в которую запишется идентификатор из заголовка ответа „Id“. Возвращается только методом POST

5. Location - Заголовок с указателем ресурса объекта. Имеет смысл для статусов 201, 3хх и только для метода POST

Настройки

...

Description

The action sends an HTTP request to invoke a RESTful web service

Action icon

Image Added

Settings of parameters

Особые условия использования 

Подробнее о REST:  https://ru.wikipedia.org/wiki/REST

Пример использования 1

Задача

Special conditions of use 

Read more about REST.

Example of use 1

Task

Send a GET request to отправить GET запрос к сервису https://dadata.ru/api/find-party/ , сохранив результат ответа в файл формата json.

Решение

воспользоваться действием "Отправить запрос". 

Реализация

, saving the result of the response to a json file.

Solution

Use the "Send request" action. 

Implementation

1. Move the "Send request" action to the workspace and set its parametersПеренести действие "Отправить запрос" на рабочую область и настроить его параметры. 
   

2. Поле The "Endpoint URL REST-сервиса" - это адрес, к которому необходимо подключиться. Более подробная информация о методе находится по ссылке" field is the address to connect to. More detailed information about the method can be found at the following link: https://dadata.ru/api/find-party/. Поле

3. The "МетодMethod" - в нашем случае необходимо указать значение GETfield - in our case it is necessary to specify the GET value. Поле

4. "Получить файлGet file" - необходимо проставить чек-бокс при необходимости. Используется, когда необходимо получить файл от сервиса. Весь ответ от сервиса будет записан в отдельный файл. 

5. Поле "Путь до папки" и "Имя файла" - необходимо заполнить, если проставлен чек-бокс в поле "Получить файл". В поле "Имя файла" необходимо указать расширение. 
   Image Removed
   

6. Нажать на кнопку "Старт" в верхней панели. 

Результат 

Программный робот отработал успешно. Сохранен файл формата json с ответом от сервиса. 

Image Removed

Image Removed

Пример использования 2

(ОШИБКА!!!)

Задача

1. field - it is necessary to check the checkbox if necessary. It is used when it is necessary to receive a file from the service. The whole response from the service will be written to a separate file. 

2. The "Path to file" and "File name" fields - must be filled in if the checkbox in the "Get file" field is checked. In the "File name" field it is necessary to specify the extension. Image Added
   

3. Click on the "Start" button in the top panel. 

Result 

The program robot completed successfully. A .json file with the response from the service was saved. 

Image Added

Image Added

Example of use 2

Task

Send a POST request to the  отправить POST запрос к сервису http://shop.bugred.ru/api/items/search/, для получения актуальных данных об изделии и разобрать ответ от сервиса, сохранив результат ответа в файл .txt.

Решение

воспользоваться действием "Отправить запрос". 

Реализация 

 service to retrieve actual product data and parse the response from the service, saving the result of the response to a .txt file.

Solution

Use the "Send request" action. 

Implementation 

Move the "Send request" action to the workspace and set its parametersПеренести действие "Отправить запрос" на рабочую область и настроить его параметры. 

1. Поле The "Endpoint URL REST-сервиса" - это адрес, к которому необходимо подключиться (REST запрос) — " field is the address to connect to (REST request) - http://shop.bugred.ru/api/items/search/. Более подробная информация о методе находится по ссылке: https://testbase.atlassian.net/wiki/spaces/SHOP/pages/1957464487/Search.
2. Поле "Метод" - в нашем случае необходимо указать значение POST.
3. More detailed information about the method can be found at the following link.
4. The "Method" field - in our case we need to specify the POST value.
5. Field "Request body" - it is necessary to specify the text of the request bodyПоле "Тело запроса" - необходимо указать текст тела запроса. {"query": "Шорты-юбкаSkirt shorts"}Поле
6. Field "Заголовки запроса" - словарь, в котором необходимо указать название заголовков и их ключи. В нашем случае словарь из 2-х записей. Пример заполнения поля "Заголовки запроса":
   Image Removed

7. Все остальные поля не имеют отношения к смыслу запроса и его формату. Поля начиная с "Выбор прокси-сервера" и заканчивая полем "Пароль пользователя для подключения к прокси-серверу" - это все поля, которые относятся к настройке прокси-сервера, если он необходим. В нашем случае, прокси-сервер отсутствует.

8. Поле "Получить файл" - необходимо проставить чек-бокс при необходимости. Используется, когда необходимо получить файл от сервиса. Весь ответ от сервиса будет записан в отдельный файл. 

9. Поле "Путь до папки" и "Имя файла" - необходимо заполнить, если проставлен чек-бокс в поле "Получить файл". В поле "Имя файла" необходимо указать расширение. 

10. Поле "Перезаписать" необходимо на тот случай, если в данной папке уже содержится файл с таким же названием и расширением.

    Image Removed

11. При запуске робота необходимо нажать на кнопку "Старт" в верхней панели. 

Результат

робот отработал успешно. Ответ от сервиса разобран роботом.

(ОШИБКА!!!)

Image RemovedImage Removed

Пример использования 3

(ОШИБКА!!!)

Задача

необходимо отправить rest-запрос на сервис https://dadata.ru/ для получения актуальных данных об организации и разобрать ответ от сервиса.

В решении  указано, как верно заполнить параметры для конкретной  задачи, а так же рассмотрены остальные параметры.  

Решение

1. Request Headers" - a dictionary in which you need to specify the name of headers and their keys. In our case, a dictionary of 2 records. Example of filling in the "Request Headers" field:
   Image Added

2. All other fields are irrelevant to the meaning of the request and its format. The fields starting from " Proxy server settings" and ending with the field "The password to the proxy server" are all fields that are related to proxy server configuration, if it is required. In our case, there is no proxy server.

3. "Get file" field - it is necessary to check the checkbox if necessary. It is used when it is necessary to receive a file from the service. The whole response from the service will be written to a separate file. 

4. The "Path to file" and "File name" fields - must be filled in if the checkbox in the "Get file" field is checked. In the "File name" field it is necessary to specify the extension. 

5. The "Overwrite" field is necessary in case this folder already contains a file with the same name and extension.

   Image Added

6. When launching the robot, you need to click on the "Start" button in the top panel. 

Result

The robot completed successfully. The response from the service is parsed by the robot.

Image Added

Example of use 3

Task

It is necessary to send rest-request to the service https://dadata.ru/ to get actual data about the organization and parse the response from the service.

The solution shows how to correctly fill in the parameters for a particular task, as well as other parameters are considered.  

Solution

Use the "Send request" action. The entire workflow is shown in the robot's flowchart воспользоваться действием "Отправить запрос". Весь процесс представлен в схеме робота  rest-zapros.robin-source   . Перенести действие "Отправить запрос" на рабочую область и настроить его параметры

Transfer the "Send request" action to the workspace and customize its parameters. 

              Image Modified

Image Modified
Разберем подробно параметры действия

Result

Image Added

Let's look at the action parameters in detail

1. The "Endpoint URL" field is the address to connect to. We will connect to the dadata service. The body of the request looks like one line. The data is formed in JSON formatПоле "URL REST-сервиса" - это адрес, к которому необходимо подключиться. Подключаться мы будем к сервису dadata. Тело запроса выглядит в одну строчку. Данные формируются в формате JSON. 
   
2. Поле The "МетодMethod" - в нашем случае необходимо указать значение POSTfield - in our case we need to specify the POST value. 
3. Поле The "Тело запросаRequest body" - необходимо указать текст тела запроса. Image Removed Если параметры должны быть переданы не в теле, а в URL, то в этом случае параметры запроса необходимо указать сразу в URL. Зависит это от сервиса, т.е как сервис ожидает получить запрос (в теле запроса или в field - it is necessary to specify the text of the request body.  Image Added  If the parameters should be passed not in the body, but in the URL, then in this case the parameters of the request should be specified in the URL. It depends on the service, i.e. how the service expects to receive the request (in the body of the request or in the URL). 
4. Поле The "Параметры формыForm Parameters" - в данном поле можно заполнить значения для тела запроса. Отличие от поля "Тело запроса" : "Тело запроса"-  это строка, "Параметры формы" - словарь.  Поле "Параметры формы" используется для метода POST. В словаре указываются в виде ключей названия объектов JSON , название элементов  и далее значения по этим элементам. 
5. Поле "Параметры запроса" - нужно на тот случай, если сервис ожидает, что параметры запроса будут переданы через URL, а не через тело запроса. 
6. Поле "Заголовки запроса" - словарь, в котором необходимо указать название заголовков и их ключи. В нашем случае словарь из 3-х записей:
   Image Removed
7. Пример заполнения поля "Заголовки запроса":
   Image Removed
8. Один из заголовков - это заголовок с авторизацией.  Его можно указать в поле "Авторизация", но так же ошибкой не будет, если данный заголовок будет указан в поле "Заголовки запросов". 
9. Поле "Путь к файлу для отправки методом POST"- необходимо указать путь до файла с запросом, если он требуется. 
10. Все остальные поля не имеют отношения к смыслу запроса и его формату. Поля начиная с "Выбор прокси-сервера" и заканчивая полем "Пароль пользователя для подключения к прокси-серверу" - это все поля, которые относятся к настройке прокси-сервера, если он необходим
    Image Removed
11. В поле "Выбор прокси-сервера" необходимо выбрать какой вариант использовать
    Image Removed
12. Если системный прокси-сервер, то будут использоваться настройки сервера, которые установлены в самой вашей системе под которой работает робот. 
13. Если выбрано значение "Без прокси-сервера" , то в этом случае не используются ни системные настройки , ни какие-либо другие. 
14. При выборе значений "Системный прокси-сервер" или "Без прокси-сервера", поля ниже можно не заполнять. 
15. Только если выбрано значение "Пользовательский прокси-сервер" необходимо заполнить поля ниже (выделены на скрине). 
    Image Removed
16. Остальные поля связаны с получением файла от сервиса. 
17. Поле "Получить файл" - необходимо проставить чек-бокс при необходимости. Используется, когда необходимо получить файл от сервиса. Весь ответ от сервиса будет записан в отдельный файл. 
18. Поле "Путь до папки" и "Имя файла" - необходимо заполнить, если проставлен чек-бокс в поле "Получить файл". В поле "Имя файла" необходимо указать расширение. 
19. Поле "Перезаписать" необходимо на тот случай, если в данной папке уже содержится файл с таким же названием и расширением
    Image Removed
20. При запуске робота необходимо нажать на кнопку "Старт" в верхней панели. 

Результат

робот отработал успешно. Ответ от сервиса разобран роботом. 

(ОШИБКА!!!)

1. field - in this field you can fill in the values for the request body. Difference from the "Request body" field: "Request body" is a string, "Form parameters" is a dictionary.  The "Form parameters" field is used for POST method. The dictionary contains JSON object names, element names and further values for these elements. 
2. The "Query parameters" field - is needed in case the service expects that the parameters of the request will be passed through the URL, and not through the body of the request.  
3. The "Request Headers" field is a dictionary in which you need to specify the name of headers and their keys. In our case, the dictionary consists of 3 entries:
   Image Added
4. Example of filling in the "Request Headers" field:
   Image Added
5. One of the headers is the header with authorization.  It can be specified in the "Authorization" field, but it will not be an error if this header is specified in the "Request Headers" field. 
6. Field "File path for sending by POST method"- it is necessary to specify the path to the file with the request, if it is required. 
7. All other fields are irrelevant to the meaning of the request and its format. Fields from "Proxy server settings" to "The password of the  proxy server" are all fields that are related to proxy server configuration, if it is required
   Image Added
8. In the "Proxy server settings" field you should choose which option to use
   Image Added
9. If the system proxy server is selected, the server settings that are set in your system under which the robot is running will be used. 
10. If "Without proxy" is selected, neither system settings nor any other settings are used. then neither system settings nor any other settings will be used. 
11. If "System proxy" or " Without proxy" is selected, the fields below can be left blank. 
12. Only if "Custom proxy" is selected, the fields below must be filled in (highlighted on the screen).  
    Image Added
13. Other fields are related to receiving a file from the service. 
14. The"Get file" field - it is necessary to check the checkbox if necessary. It is used when it is necessary to receive a file from the service. The whole response from the service will be written to a separate file. 
15. The "Path to file" and "File name" fields - must be filled in if the checkbox is checked in the "Get file" field. In the "File name" field it is necessary to specify the extension. 
16. The "Overwrite" field is necessary in case this folder already contains a file with the same name and extension
    Image Added
17. When launching the robot, you need to click on the "Start" button in the top panel. 

Result

The robot completed successfully. The response from the service is parsed by the robot.