Authentication

Attention:

Authenticating using the X-VP-AUTH-API key and X-VP-AUTH token has been deprecated. For more information, refer to Deprecated: Authenticating Using the X-VP-AUTH-API Key and X-VP-AUTH Token.

We have made major changes in our authentication infrastructure to support the OAuth 2.0 protocol and we strongly recommend clients with existing integrations to upgrade as soon as possible. If you have an existing integration and want to upgrade, please contact your Account Manager for further assistance.

OAuth 2.0

Ooyala Pulse now uses OAuth 2.0 to authenticate connections that use the Ooyala Pulse REST APIs. OAuth 2 is an open protocol for authentication used with web, mobile, and desktop applications. Every use of Ooyala Pulse REST APIs requires authentication, ensuring that only authorised users interact with Ooyala Pulse content.

API Key

Accessing the Ooyala 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 mutiple API keys for your account. Including an API key in each request as the x-o-api-key in the header is mandatory. Follow these steps to create your API key:

  1. Go to https://manager.videoplaza.com/api-key.
  2. Log in to the API Key UI using your Ooyala Pulse credentials. You see the following interface:

    API Key UI

  3. Click the CREATE NEW button.
  4. Enter the name (required) and description (optional) for the API key:

    API Key details

  5. By default, the API Key status is "Active" but you can click on the status button to deactivate it.
    Note: While the API Key status is "Deactivated", you cannot use it to make API calls. You can activate the API key at any time by clicking the status button.
  6. Click SAVE CHANGES. A pop up window appears, displaying your API key and the text This is the only time that you will be shown the API key, make sure you copy it and store the copy in a secure place. If you loose the key you can always create a new one.

    API Key pop up

    You can view the list of your API keys, activate, deactivate or delete them at any time from the Api Key UI: Delete API Key

Example Request

GET /api/1.0/campaign?status=upcoming&state=enabled HTTP/1.1
Host: api.videoplaza.com
x-o-api-key:"<your key>"

Failed Login

Authenticating with an invalid API key returns 401 Unauthorized:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <title>Videoplaza Login</title>
        <style type="text/css">
        h1, h2 {
            float: left;
            margin: 0;
            padding: 0;
        }

        h1 {
            font: 45pt Arial, Verdana, Sans-Serif;
            color: #ec008a;
        }

        h2 {
            font: 10pt Arial, Verdana, Sans-Serif;
            color: #ec008a;
            padding: 10px 0 0 0;
        }

        form p {
            float: left;
            padding: 0 0 0 10px;
        }

        form label {
            display: block;
            font: 10pt Arial, Verdana, Sans-Serif;
        }
    </style>
    </head>
    <body>
        <div style="background: #ffffff url(/core/images/login_background.png); margin: 10% auto; width: 676px; height: 362px;">
            <div style="padding: 230px 0 0 130px; clear:both;">
                <form method="post" action="/core/login_process">
                    <p>
                        <label for="username">Username</label>
                        <input type="text" name="username" id="username"/>
                    </p>
                    <p>
                        <label for="password">Password</label>
                        <input type="password" name="password" id="password"/>
                    </p>
                    <p>
                &nbsp;
                        <br/>
                        <input type="submit" value="Login"/>
                    </p>
                </form>
            </div>
        </div>
    </body>
</html>

Was this article helpful?