Step 2 - Getting Started with Postman
In this document, you will learn how to use Postman to make requests to the ZEN Master API. We will cover these topics:
- Download the API definition
- Import the API definition
- Set collection variables
- Send a GET request for Sources
As an API user, you will have admin access in ZEN Master, allowing you to view objects and update all settings available to administrators.
You can download a copy of the ZEN Master API definition in both YAML and JSON format. Either format will work in Postman.
Login to the Zixi Customer Portal.
In the left navigation, select Documentation.
Select the By Type tab, and then select ZEN Master API.
To download the JSON file:
Open the ZEN Master API HTML Reference.
At the top of the API Reference, click the Download button. A JSON file will be downloaded to your computer.
To download the YAML file:
- In the Zixi Customer Portal, locate the ZEN Master API YAML file.
- Click the Download button. A zipped YAML file will be downloaded to your computer.
In Postman, you can import an API definition using either the YAML or the JSON format.
In a web browser, navigate to https://www.postman.com/
Sign in or create an account.
In the left sidebar, click Import.
Select your copy of either the YAML or the JSON API definition file.
Choose to import the definition as a collection and click Import.
Next, you will provide values for the ZEN Master API collection variables.
Return to the Postman UI.
In the left sidebar, select the Zixi ZEN Master API collection, and then select Variables. Here, you’ll define collection variables for base URL and API Key.
For the baseUrl variable, enter the ZEN Master API base URL: https://api.zen.zixi.com/v2
Next, create a variable named apiKey.
If you don’t already have a ZEN Master API authentication key, see the Getting Started with Authentication document.
Paste the ZEN Master API Key value that you created in the Zixi ZEN Master dashboard. Paste the same value into the Initial value and the Current value fields.
Click Save. Your variables are ready to use with any request within the collection.
Next, you are ready to send a request to the ZEN Master API.
Return to Postman.
In the left sidebar, select the Zixi ZEN Master API collection, and expand the sources folder.
Select GET list Sources.
For the GET URL endpoint, remove all of the query parameters.
Click Send.
You should see response data with an array of sources.
For a complete list of request paths, see the Zixi ZEN Master API Reference.
