| Следующая версия | Предыдущая версия |
| product:api:list:postman [02.11.2024 08:50] – создано ekaterina.menkhuzina | product:api:list:postman [05.11.2024 11:13] (текущий) – ekaterina.menkhuzina |
|---|
| ====== Вызов методов API с помощью Postman ====== | ====== Вызов методов API с помощью Postman ====== |
| | [[https://www.postman.com/|Postman]] — это сервис для создания, тестирования, документирования, публикации и обслуживания API. |
| |
| | Вызов метода с помощью [[https://www.postman.com/|Postman]]: |
| | |
| | 1. Создать новую коллекцию запросов и переименовать ее (по необходимости): |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman1.png |}}</image> |
| | \\ |
| | 2. В коллекции создать новый каталог и также переименовать его (по необходимости): |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman2.png |}}</image> |
| | \\ |
| | 3. В каталоге создать новый запрос - вызвать функцию "Add request": |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman3.png |}}</image> |
| | \\ |
| | 4. Выбрать тип запроса "POST" и вставить в строку адреса запроса название сервера и путь **components/services/.asmx** со страницы [[product:api:list|Описание методов API]]: |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman4.png?direct&900 |}}</image> |
| | \\ |
| | 5. Перейти на закладку "Headers" и в таблице создать заголовки (у SOAP два заголовка): |
| | * Content-Type = ''text/xml;charset=utf-8''; |
| | * SOAPAction = заголовок взять со страницы описания API-функции, например, для метода [[product:api:list:authenticate|Authenticate]] заголовок - ''http://streamline/Authenticate'' (пространство имен + название метода). |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman5.png?direct&900 |}}</image> |
| | \\ |
| | 6. Перейти на закладку "Body": |
| | * установить переключатель типа данных в положение "row"; |
| | * выбрать формат данных "XML". |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman6.png?direct&900 |}}</image> |
| | \\ |
| | 7. Скопировать со страницы описания API-функции (например, [[product:api:list:authenticate|Authenticate]]) код запроса и вставить его в поле тела запроса в Postman. Сохранить запрос (кнопка "Save"): |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman7.png |}}</image> |
| | \\ |
| | 8. В поле запроса указать передаваемые параметры. Например, в методе API [[product:api:list:authenticate|Authenticate]] в передаваемых параметрах нужно указать логин и пароль необходимого пользователя: |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman8.png |}}</image> |
| | \\ |
| | 9. После нажатия на кнопку "Send" при корректно выполненном методе внизу появится строка с возвращаемыми параметрами: |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman9.png |}}</image> |
| | \\ |
| | Готовый пример вызова метода: |
| | |
| | <image shape="thumbnail">{{ :product:api:list:postman10.png |}}</image> |