Работа с запросами в Postman

Glossary Item Box

Общие сведения

Postman — это мощный набор инструментов для тестирования API. Он является средой разработки, которая позволяет создавать, тестировать, документировать, контролировать и публиковать документацию для API.

Работа с запросами в Postman состоит из следующих этапов:

Добавление запроса.
Настройка запроса.
Выполнение запроса.
Сохранение запроса.

Postman рекомендуется использовать для тестирования запросов при интеграции c Creatio по протоколу OData 3 или OData 4. Больше информации о работе в Postman содержится в документации Postman.

Работа с запросами

Добавление запроса

Добавить запрос в Postman можно следующими способами:

По кнопке [New] —> [Request] в блоке [Building blocks] вкладки [Create New] (рис. 1).
Рис. 1. — Добавление запроса
В выпадающем меню кнопки [New] —> [Request] (рис. 2).
Рис. 2. — Пункт [Request] в выпадающем меню кнопки [New]

В окне нового запроса (рис. 3) заполните следующие поля (табл. 1):

Табл. 1. — Поля для создания запроса

Имя поля	Описание
[Request name]	Имя запроса.
[Request description (Optional)]	Описание запроса (при необходимости).
[Search for a collection or folder]	Поиск ранее созданной коллекции запросов или создание новой.

Рис. 3. — Окно нового запроса

После заполнения полей нажмите [Save], которая становится активной только после заполнения поля [Search for a collection or folder].

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

Для настройки запроса выполните следующие действия:

Выберите метод запроса (рис. 4).
Рис. 4. — Выпадающий список для выбора метода запроса
Введите строку запроса.
Установите формат данных запроса. Для этого перейдите на вкладку [Body], установите опцию raw и выберите тип JSON (рис. 5).
Рис. 5. — Выбор формата данных запроса
Для методов POST и PATCH заполните тело запроса.
Перейдите на вкладку [Headers] и установите следующие заголовки:
```
Accept: application/json
Content-Type: application/json; charset=utf-8
ForceUseSession: true
```