Import and use Swagger documentation in Postmann

Requirements

• API endpoint has been created

• API key for the endpoint has been created

• Swagger documentation was created (.yml file) and saved in an accessible directory.

Step-by-step guide

To import and use the Swagger documentation in Postmann, proceed as follows:

Import Swagger documentation

1. Launch Postman.

2. Click on the "APIs" menu item in the left-hand navigation area.

   

3. Click on "Import".

   

   An import dialog is displayed.

4. Select the previously saved .yml file.

5. Click on "Import".

   

   A dialog is displayed to confirm the import.

   The Intrexx API is displayed.

   

   Deposit API key

6. Click on the directory with the name of the imported Swagger documentation.

   

7. Click on the "Authorization" tab.

8. In the "Type" selection list, select the value "API Key" ().

9. Enter the value "X-API-KEY" in the "Key" input field ().

10. In the "Value" input field, enter the API key that you copied from Intrexx ().

11. In the "Add to" selection field, select the "Header" value ().

12. Save the information.

    

    Executing requests

    You can now execute the requests.

13. Click (for example) on the API endpoint "Get-one-data-record-in-store" ().

14. On the "Params" tab, replace the value "tempor Duis" in the "VALUE" column with the primary key of the data set you wish to query ().

    

15. Click on "Send".

    The return values you have defined are displayed under "Body" ().

More information

Postman Learning Center