Step 1: Getting Started with Authentication

2min

Overview

The ZEN Master Control Plane consists of video management software for complete visibility across your media supply chain. You can use the ZEN Master API to manage your deployment programmatically.

To access the ZEN Master API, you will use an API authentication key.

As an API user, you will have admin access in ZEN Master, allowing you to view objects and update all settings available to administrators.

Create an API Key

You will use a ZEN Master API authentication key when sending requests to the ZEN Master API. You can configure this key to be read-only or allow updates in ZEN Master.

To create a ZEN Master API Key, follow these steps:

1

In a web browser, navigate to https://{youraccount}.zen.zixi.com

2

When you sign in, you should see the Zixi ZEN Master dashboard.

ZEN Master Dashboard

3

In the left navigation, hover over Configuration and select API Keys.

Configuration Menu - API Keys

4

To create a new key, click Add Key. You need to be an Admin user to create new API keys.

Add Key Button

5

Enter a name for the key using any alphanumeric value.

6

To restrict updates with this key, select the Read only checkbox.

Create API Key Dialog

7

Click Save.

8

You should now see your new key in the API Keys list. Click Show to see the key value.

Show/Copy New Key

9

Click Copy to copy the key value to your clipboard.

Once you have created your ZEN Master API authentication key, you can use it to make requests to the ZEN Master API, using your tool of choice.