Connectors / Service / Brightcove

Offers a robust video platform that allows individuals and businesses to share, stream and host. (updated: 1657118141645)

Brightcove

Brightcove is a video communication platform that allows individuals and businesses to share, stream and host.

Overview

Brightcove is a video communication platform that allows individuals and businesses to share, stream and host. It helps them engage their audiences, monetize content and convert prospects with industry leading reliability, scalability and security.

API Information

The Base URL used for the Brightcove connector is https://cms.api.brightcove.com/v1. More information can be found on their main API Documentation(v1) site.

Authentication

Within the builder, click on the Brightcove connector to display the connector properties panel. Select the 'Auth' tab and click the 'New authentication' button.

Brightcove-auth

In the Tray.io authentication pop-up modal, name the authentication in a way that will quickly identify it within a potentially large list. For example, whether it is a Sandbox or Production auth, etc.

Consider who/ how many people will need access to this authentication when choosing where to create this authentication ('Personal' or 'Organisational').

The second page asks you for your 'Client ID', 'Client Secret' and 'Account ID' credentials.

Brightcove-auth-2

To get these fields, head to the Brightcove dashboard. Click on the gear icon available on the bottom left.

Here you can see the 'Account ID' on the 'Account Information' page.

brightcove-account-id

To get the 'Client Secret' and 'Account ID', select 'API Authentication' from the left navigation panel.

Brightcove-dashboard

The 'API Authentication' page will open displaying your current client registrations.

brightcove-client-registrations

Click 'Register New Application'. Enter a 'Name' and 'Description' for the client registration.

Select one or more of your accounts based on your requirement for authorization.

brightcove-select-accounts 1

Select the required API(s) and permission(s) to enable this registration.

brightcove-select-apis 1

Click 'Save'.

A 'Client ID' and 'Client Secret' will be returned. Copy the 'Client Secret' and store it in a secure location as the client secret will not be displayed again.

brightcove-client-secret

Once you have added these fields to your Tray.io authentication pop-up window, click the 'Create authentication' button. 

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a powerful feature that you can use when there is an endpoint in Brightcove that is not used by any of our operations.

To use this, you will first of all need to research the endpoint in the Brightcove API documentation to find the exact format that Brightcove will be expecting the endpoint to be passed in.

For example, say that the 'Get a list of players' operation did not exist in our Brightcove connector, and you wanted to use this endpoint. You would use the

Brightcove API docs to find the relevant endpoint - which in this case is a 'GET' request called: '/v2/accounts/{account_id}/players'.

More details about this endpoint can be found here.

get-a-list-of-players

Based on the information provided in the above API call doc, you need to configure the following attributes on your Tray platform:

  • Method: GET

  • URL:

    • Full URL: https://players.api.brightcove.com/v2/accounts/6265598906001/players

  • Body Type: none

brightcove-raw-http

Once the API call is executed successfully, you should get the following results:

brightcove-raw-http-op

Example Usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors.

Below is an example of a way in which you could potentially use the Brightcove connector to list all the playlists from the selected account. Loop through each playlist's ID to get a list of videos from that playlist.

The overall logic of the workflow is:

  1. Workflow is triggered using the Manual trigger.

  2. Using the 'List Playlist' operation the Brightcove connector lists all the playlists for the selected account.

  3. It then loops through all the playlist IDs received from the previous step.

  4. At the end using the 'List videos in playlist' operation the Brightcove connector gets the list of songs from each playlist.

Your completed workflow should look similar to this:

brightcove-complete-wf

Step-by-step Explanation

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our managing data best practices guide.

All Operations

Latest version:

1.2

Create playlist

Create a new playlist.

Create video

Create a new video object in the account.

Delete playlist

Delete a playlist.

Delete videos

Delete one or more videos.

Delete videos from all playlists

Remove video from all playlists for the account.

Get playlist count

Retrieve a count of playlists in the account.

Get video count

Get counts of videos for the account or search.

Get video count in playlist

Retrieve a count of the videos in a playlist for the account.

List account videos

Retrieve all video objects for a given account.

List account videos DDL

List account videos by reference ID DDL

List playlists

List playlists for the account..

List playlists DDL

List playlists by ID

List playlists by ID.

List video playlists

Retrieve an array of Manual playlists that contain a video object for a given account.

List videos by ID or reference ID

Retrieve one or more video objects.

List videos in playlist

List the videos in a playlist.

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Update playlist

Update a playlist for the account.

Update video

Update video metadata.