API credentials

❗️

Warning

Dear Publisher, Starting March 1st, 2024, we will deprecate API v2. To ensure continued service, please migrate to API v3 before the deprecation date.

In the following section you can get more familiar on how to obtain an API key and how to programmatically connect to Brid to manage your content.

Either you want to upload a video, create a player, manage ads or playlists or simply grab an embed code for your video content you can use our API to leverage all of this and much more.
Using our API you can programmatically integrate most of the CMS functionality into your own platform and simplify the process of managing your video library in Brid.

Obtaining an API key as an Account owner

To obtain an API key from Brid platform do the following steps:

1. Go to your websites settings screen by clicking on the cogwheel icon next to the website name at the top:

2. Once you go to the website settings page, you will be able to see the API section where you can generate API key.

3. If "Click here" link is clicked in the above section, you will get redirected to the Authorize page where you will have to authorize Brid application to access your account data on your behalf.

4. After clicking Authorize button, you will get redirected to the website settings page but this time you will be provided with your API credentials as seen on the following screenshot:

5. You are all set. Once you have generated your API key, you will be able to start using our API and create awesome apps using your Brid content.

❗️

Warning

Your Bearer token must be present in each API call to perform authorization.

Below you will find some basic authentication examples using different languages.

Example

$url = "https://<<brid_api_url>>/apiv3/adtag/list/{PARTNER_ID}.json";

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$headers = array(
   "Accept: application/json",
   "Authorization: Bearer YOUR_<<company>>_BEARER_TOKEN",
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
//for debug only!
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);

$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);

import requests
from requests.structures import CaseInsensitiveDict

url = "https://<<brid_api_url>>/apiv3/adtag/list/{PARTNER_ID}.json"

headers = CaseInsensitiveDict()
headers["Accept"] = "application/json"
headers["Authorization"] = "Bearer YOUR_BRID_TV_BEARER_TOKEN"


resp = requests.get(url, headers=headers)

print(resp.status_code)

#!/bin/bash

curl -X GET https://<<brid_api_url>>/apiv3/adtag/list/{PARTNER_ID}.json -H "Accept: application/json" -H "Authorization: Bearer YOUR_BRID_TV_BEARER_TOKEN"

API permissions

Each user role in Brid has specific permissions which will allow/disable specific actions through the API.
All user roles except Account owner will find the API section in their Account details page. The process is the same as explained above.
You can read more about different user roles and their permissions in Brid here: https://brid.zendesk.com/hc/en-us/articles/200299741