Pulse REST API authentication
Pulse uses OAuth 2.0 to authenticate connections that use the Pulse REST APIs. OAuth 2 is an open protocol for authentication used with web, mobile, and desktop applications. Every use of Pulse REST APIs requires authentication, ensuring that only authorized users interact with Pulse content.
Accessing the Pulse REST API requires an API key, which is your global account key
and it is not connected to a specific user. You can create multiple API keys for
your account. Including an API key in each request as the
x-o-api-key in the header is mandatory.
Below is an example API request:
GET /api/1.0/campaign?status=upcoming&state=enabled HTTP/1.1 Host: api.videoplaza.com x-o-api-key:"<your key>"
Authenticating with an invalid API key returns
Create API key
Follow these steps to create your API key:
- Go to https://manager.videoplaza.com/api-key.
- Log in to the API keys UI using your Pulse credentials.
You see the following interface:
- Click Create API key.
- Enter the Name (required) and
Description (optional) for the API key:
By default, the API key status is Enabled but you can click the button to disable it.Note: While the API key status is Disabled, you cannot use it to make API calls. You can enable the API key at any time by clicking the status button.
- Click Save & Close. A pop-up window appears,
displaying your API key. This is the only time Pulse shows the API key.
- Click the copy icon to copy the API key. Make sure to store it in a secure place.
- Click Close when you are done. This takes you back to the API keys list.
- create new API keys
- view the list of all API keys
- enable or disable API keys
- delete API keys
- click on the name of any of the API keys to edit the name, description, and status of the API key