--- title: Step 2 - Getting Started with Postman slug: zen-master-api/step-2-getting-started-with-postman docTags: createdAt: 2025-03-06T14:24:14.031Z --- # Overview Postman is an API client used to build and test RESTful APIs. You can use Postman to send HTTP requests (GET, POST, PUT, DELETE) to the ZEN Master API. The response from the API will be a JSON object. In this document, we'll cover these topics: - Install Postman - Download the API definition - Import the API definition - Define Environment variables - Link to Postman Vault (optional) - 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. # Install Postman To get to the Postman homepage, open a web browser and navigate to: - ****[https://www.postman.com/](https://www.postman.com/) There are a few ways to use Postman: - Use the web version - Download the Postman app and install it on your machine - Use the VS Code extension Create a Postman account or sign in. # Download the API definition Download a copy of the ZEN Master API definition. Either YAML or JSON format works in Postman. ::::WorkflowBlock :::WorkflowBlockItem Log in to the Zixi Customer Portal. ::: :::WorkflowBlockItem In the left navigation, select **Documentation**. ::: :::WorkflowBlockItem Select the **By Type** tab, and then select **ZEN Master API**. ::Image[]{src="https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/Jr3_q_prCVQrB5gU9_CVI_.blob" size="90" width="856" height="288" position="center" showCaption="false"} ::: :::WorkflowBlockItem To download the JSON file: - Open the **ZEN Master API HTML Reference**. ::Image[]{src="https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/9AOnSVwUVEwytQjpfkV1B_.blob" size="80" width="772" height="108" position="center" showCaption="false"} - At the top of the API Reference, click the **Download** button. A JSON file will be downloaded to your computer. ::Image[]{src="https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/T2eweJxJ5WnTOUHnprXjY_.blob" size="80" width="884" height="212" position="center" showCaption="false"} ::: :::WorkflowBlockItem 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. ::Image[]{src="https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/-ey5q1DZA0kmDRK_4RNU6_.blob" size="80" width="816" height="100" position="center" showCaption="false"} ::: :::: # Import the API definition In Postman, the API definition (YAML or JSON) will be imported as a Collection. :::::WorkflowBlock :::WorkflowBlockItem In a web browser, navigate to [https://www.postman.com/](https://www.postman.com/) ::: :::WorkflowBlockItem Sign in or create an account. ::: :::WorkflowBlockItem In the left sidebar, click **Import**. ::Image[]{src="https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/o44VSfMbkGRJPp1rLriCy_.blob" size="80" width="462" height="188" position="center" showCaption="false"} ::: :::WorkflowBlockItem Select your copy of either the YAML or the JSON API definition file. ::: ::::WorkflowBlockItem Select **Postman Collection**. This will import the API definition as a Postman Collection. :::hint{type="info"} Selecting **OpenAPI 3.0 Specification with a Postman Collection** will create a Postman Collection and a specification on **Spec Hub**, which is used for designing an API. ::: ::Image[]{src="https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/XHZWRvsE_j5_9TWQKmpzl_.blob" size="80" width="768" height="292" position="center" showCaption="false"} :::: :::WorkflowBlockItem Click **Import**. ::: ::::: # Define Environment variables Next, you will define Postman variables to provide access to the ZEN Master API. There are several ways to do this. We'll focus on Environment variables. Setting up Postman Environments makes it easy to switch between staging and production, which have different URLs and API Key values. :::::WorkflowBlock :::WorkflowBlockItem Return to the Postman UI. ::: :::WorkflowBlockItem In the left navigation, select **Environments** and click **+** to create a new Environment. ::Image[]{src="https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/sqIFydr_H8Ov7F3kn7JHk_image.png" size="80" width="770" height="404" position="center" showCaption="false"} ::: :::WorkflowBlockItem Rename the Environment. ::: ::::WorkflowBlockItem Add the **baseUrl** variable: - For the baseUrl variable, enter the ZEN Master API base URL: [https://api.zen.zixi.com/v2](https://api.zen.zixi.com/v2) - Leave the **Initial value** field blank. Paste the **baseUrl** value into the **Current value** field. :::hint{type="warning"} Never put sensitive data in the **Initial value**. If you are in a shared or public workspace, anyone with access to that environment will see your data. The **Current value** is stored locally on your machine and is NOT synced to the Postman cloud by default. ::: ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/ZNlJcOwYOE4bbpyX-rJYE_image.png) :::: :::WorkflowBlockItem Add the **apiKey** variable: - If you don’t already have a ZEN Master API authentication key, see the **Getting Started with Authentication** document. - Leave the **Initial value** field blank. Paste the ZEN Master API Key value (you created in the Zixi ZEN Master dashboard) into the **Current value** field. - Set the variable **Type** to **secret**. The value is masked in the Postman UI. ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/ixKe87LAoLyYPuZlt9SQ__image.png) ::: :::WorkflowBlockItem Click **Save**. ::: :::WorkflowBlockItem In the left navigation, click **Collections** to return to your ZEN Master API Collection. ::: :::WorkflowBlockItem In the top right, expand the **No environment** drop-down menu and select the Environment that you just created. ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/fNim1LPeJTpUjk5z4Al1v_image.png) ::: :::WorkflowBlockItem Your Environment variables are now available for each method request in your Collection. ::: ::::: # Link to Postman Vault (optional) For maximum security of your API Key values, it is best practice to combine Environment Variables with Postman Vault. Postman Vault is designed to store your sensitive data locally and securely. It keeps your secrets off the cloud and local to your machine. Let's add our API Key to the Postman Vault. :::::WorkflowBlock :::WorkflowBlockItem In Postman, in the bottom right corner, select **Vault**. ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/nd7YFPtgzdaS3jqSIAQrS_image.png) ::: ::::WorkflowBlockItem Copy your Vault key and save it in a password manager. You will need it to log in to your Vault after logging out. :::hint{type="danger"} Losing your Postman Vault key will result in the loss of all of your secrets. ::: ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/ZHNrD0kDTbfi4sJBWGTtZ_image.png) :::: :::WorkflowBlockItem Click **Open Vault**. ::: :::WorkflowBlockItem Store your API Key in the Postman Vault (ex, **myApiKey**). ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/NXQyK8bggvLZNOesjjHCc_image.png) ::: :::WorkflowBlockItem Return to your Environment variables and replace the **Current value** with **\{\{vault\:myApiKey}}** ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/xM6CUYCCxlfd-egjVGdAj_image.png) ::: :::WorkflowBlockItem Set the **Type** to secret for UI masking. ::: :::WorkflowBlockItem Return to your Collection and select your Environment. You are ready to send requests. ::: ::::: # Send a GET request for Sources Send a request to the ZEN Master API to test your connection. ::::WorkflowBlock :::WorkflowBlockItem In the left sidebar, select the **Zixi ZEN Master API** collection, and expand the **sources** folder. ::: :::WorkflowBlockItem Select **GET list Sources**. ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/_hVkffah-o2RmHr5QJF4L_.blob) ::: :::WorkflowBlockItem For the **GET URL** endpoint, remove all of the query parameters. ::: :::WorkflowBlockItem Click **Send**. ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/_Ga1IVs8iISCbZhPANZtq_.blob) ::: :::WorkflowBlockItem You should see response data with an array of sources. ![](https://api.archbee.com/api/optimize/mzxtTQEvCNIdUNgF2kuwJ/sTgWMG6JJSrQLV8353kQj_.blob) ::: :::WorkflowBlockItem For a complete list of request paths, see the **Zixi ZEN Master API Reference**. ::: ::::