JavaScript API Reference

Introduction

This article provides a reference to all available Brid Player JavaScript API calls. For more in-depth instructions on implementation, see our Brid Player Developer Guide. To see example code for each API call, visit our Brid Player Examples section.


Some important information that you may need to get started with API usage

In many examples of the API you will need a player ID, video ID and a site/partner ID. To get these values for your account please follow these steps noted below.

Get a player and/or partner ID
To get a player ID that you can use with the API follow these steps:

  1. Login into the CMS.
  2. Select a site under the MANAGE VIDEOS option on the main left-hand menu.
  3. Select the PLAYERS section on the main left-hand menu.
  4. Click on a player name in your player list.
  5. Notice the following URL in your browsers address bar - https://cms.brid.tv/players/edit/XXXXX?partner_id=YYYY

XXXXX is the ID of your player so use this number wherever you need for API purposes.
YYYY is the ID of your site/partner so use this number wherever you need for API purposes.

There is a slighlty quicker way to get a specific player ID as we provide this data on your players list as well right under the name of each of your player.


Get a video ID
To get a video ID that you can use with the API follow these steps:

  1. Login into the CMS.
  2. Select a site under the MANAGE VIDEOS option on the main left-hand menu.
  3. You will be redirected to your video list.
  4. Click on a video name in your video list to edit that specific video.
  5. Notice the following URL in your browsers address bar - https://cms.brid.tv/videos/edit/ZZZZZZ?partner_id=YYYYY

ZZZZZZ is the ID of your video so use this number wherever you need for API purposes.
YYYYY is the ID of your site/partner so use this number wherever you need for API purposes.