Importing and Using Swagger Documentation in Postmann

Requirements

• API endpoint created

• An API key for the endpoint has been created

• Swagger documentation was generated (as a .yml file) and saved in an accessible directory.

Step-by-Step

To import and use the Swagger documentation in Postmann, follow these steps:

Import Swagger Documentation

1. Launch Postman.

2. In the left navigation pane, click the "APIs" menu item.

   

3. Click "Import."

   

   An import dialog box appears.

4. Select the .yml file you saved earlier.

5. Click "Import."

   

   A dialog box appears confirming the import.

   The Intrexx API is displayed.

   

   Enter API Key

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

   

7. Click the "Authorization" tab.

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

9. In the "Key" input field, enter the value "X-API-KEY" ().

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

11. In the "Add to" drop-down menu, select "Header" ().

12. Save your information.

    

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

    

15. Click "Send."

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

More Information

Postman Learning Center