Overview: Social API (beta)

Product(s)
Video Cloud
Role(s)
API Developer
Topic(s)
Social Sharing

This topic provides an overview of the Social API.

Introduction

The Social API allows to get the social sharing status and history for you videos. It is mainly intended to help with CMS integrations, to allow your users to view this information in your own CMS system.

For full details of requests, see the API reference.

Base URL

The base URL for the API is:

https://social.api.brightcove.com/v1

Authentication

Authentication for requests requires an Authorization header :

      Authorization: Bearer {access_token}

The access_token is a temporary OAuth2 access token that must be obtained from the Brightcove OAuth service. For details on how to obtain client credentials and use them to retrieve access tokens, see the Brightcove OAuth Overview.

Operations

When you request client credentials, you will need to specify the type of account access or operations that you want. The following is a list of the currently supported operations for the Social API :

  • video-cloud/social/status/read

Note that while the Social API is in beta, permissions for it are not available in the Studio Admin section for Managing API Credentials. Instead, you will have to use the OAuth API to create your credentials. However, Brightcove Learning Services, has created a simple online tool for doing this.

Summary of requests

In the current version of the API, only GET requests are supported. There are two groups of requests, summarized in the following sections.

Status requests

Status requests return the current social sharing status for videos. You can get the status for all videos in your account, or a specific video.

History requests

History requests return the social sharing history for videos. You can get the history for all videos in your account, or a specific video.