Import and use Swagger documentation in Postman

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 Swagger documentation in Postman, proceed as follows:

Import Swagger Documentation

1. Launch Postman.

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

   

3. Click on "Import".

   

   An import dialog is displayed.

4. Select the previously saved .yml file.

5. Click on "Import".

   

   A dialog confirming the import will be displayed.

   The Intrexx API is displayed.

   

   Deposit API key

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

   

7. Click the Authorization tab.

8. In the Type drop-down list, select the "API Key" value ().

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, in the "VALUE" column, replace the "tempor Duis" value with the primary key of the record you want to query ().

    

15. Click "Send".

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

More information

Postman Learning Center