Отправить запрос Версия 15 (Java)

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

Описание

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

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

Параметры

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

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

Настройки

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

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

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

Задача

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

Решение

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

Реализация

1. Перенести действие "Отправить запрос" на рабочую область и настроить его параметры. 
   

2. Поле "URL REST-сервиса" - это адрес, к которому необходимо подключиться. Более подробная информация о методе находится по ссылке: https://dadata.ru/api/find-party/. 

3. Поле "Метод" - в нашем случае необходимо указать значение GET. 

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

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

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

Результат 

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

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

Задача

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

Решение

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

Реализация 

Перенести действие "Отправить запрос" на рабочую область и настроить его параметры. 

1. Поле "URL REST-сервиса" - это адрес, к которому необходимо подключиться (REST запрос) — http://shop.bugred.ru/api/items/search/. Более подробная информация о методе находится по ссылке: https://testbase.atlassian.net/wiki/spaces/SHOP/pages/1957464487/Search.
2. Поле "Метод" - в нашем случае необходимо указать значение POST.
3. Поле "Тело запроса" - необходимо указать текст тела запроса. {"query": "Шорты-юбка"}
4. Поле "Заголовки запроса" - словарь, в котором необходимо указать название заголовков и их ключи. В нашем случае словарь из 2-х записей. Пример заполнения поля "Заголовки запроса":
   

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

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

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

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

   

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

Результат

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

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

Задача

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

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

Решение

воспользоваться действием "Отправить запрос". Весь процесс представлен в схеме робота rest-zapros.robin-source . 

Перенести действие "Отправить запрос" на рабочую область и настроить его параметры. 

              



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

1. Поле "URL REST-сервиса" - это адрес, к которому необходимо подключиться. Подключаться мы будем к сервису dadata. Тело запроса выглядит в одну строчку. Данные формируются в формате JSON. 
   
2. Поле "Метод" - в нашем случае необходимо указать значение POST. 
3. Поле "Тело запроса" - необходимо указать текст тела запроса.  Если параметры должны быть переданы не в теле, а в URL, то в этом случае параметры запроса необходимо указать сразу в URL. Зависит это от сервиса, т.е как сервис ожидает получить запрос (в теле запроса или в URL). 
4. Поле "Параметры формы" - в данном поле можно заполнить значения для тела запроса. Отличие от поля "Тело запроса" : "Тело запроса"-  это строка, "Параметры формы" - словарь.  Поле "Параметры формы" используется для метода POST. В словаре указываются в виде ключей названия объектов JSON , название элементов  и далее значения по этим элементам. 
5. Поле "Параметры запроса" - нужно на тот случай, если сервис ожидает, что параметры запроса будут переданы через URL, а не через тело запроса. 
6. Поле "Заголовки запроса" - словарь, в котором необходимо указать название заголовков и их ключи. В нашем случае словарь из 3-х записей:
   
7. Пример заполнения поля "Заголовки запроса":
   
8. Один из заголовков - это заголовок с авторизацией.  Его можно указать в поле "Авторизация", но так же ошибкой не будет, если данный заголовок будет указан в поле "Заголовки запросов". 
9. Поле "Путь к файлу для отправки методом POST"- необходимо указать путь до файла с запросом, если он требуется. 
10. Все остальные поля не имеют отношения к смыслу запроса и его формату. Поля начиная с "Выбор прокси-сервера" и заканчивая полем "Пароль пользователя для подключения к прокси-серверу" - это все поля, которые относятся к настройке прокси-сервера, если он необходим
    
11. В поле "Выбор прокси-сервера" необходимо выбрать какой вариант использовать
    
12. Если системный прокси-сервер, то будут использоваться настройки сервера, которые установлены в самой вашей системе под которой работает робот. 
13. Если выбрано значение "Без прокси-сервера" , то в этом случае не используются ни системные настройки , ни какие-либо другие. 
14. При выборе значений "Системный прокси-сервер" или "Без прокси-сервера", поля ниже можно не заполнять. 
15. Только если выбрано значение "Пользовательский прокси-сервер" необходимо заполнить поля ниже (выделены на скрине). 
    
16. Остальные поля связаны с получением файла от сервиса. 
17. Поле "Получить файл" - необходимо проставить чек-бокс при необходимости. Используется, когда необходимо получить файл от сервиса. Весь ответ от сервиса будет записан в отдельный файл. 
18. Поле "Путь до папки" и "Имя файла" - необходимо заполнить, если проставлен чек-бокс в поле "Получить файл". В поле "Имя файла" необходимо указать расширение. 
19. Поле "Перезаписать" необходимо на тот случай, если в данной папке уже содержится файл с таким же названием и расширением
    
20. При запуске робота необходимо нажать на кнопку "Старт" в верхней панели. 

Результат

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