Overview: In-Page Experience API

Product(s)
Gallery
Role(s)
API Developer
Task(s)
Create an In-Page Experience
API(s)
In-Page Experiences API (Client)
In-Page Experiences API (Platform)

This topic provides an overview of the In-Page Experiences API.

Introduction

There are two APIs associated with In-Page Experiences, but they are used for very different purposes:

In-Page Experiences API (REST)

The In-Page Experiences API is a REST API that allows you to manage In-Page experiences programmatically. It is primarily intended for use in integrating the Video Cloud platform with your CMS application.

Also see the full API Reference for complete details of the available requests.

In-Page Experiences Client API

The In-Page Experiences Client API is a JavaScript library that helps you manage the behavior of the In-Page Experience at runtime, similar to the way the Brightcove Player API is used to control the behavior of the player. The API is available on any page that runs one or more Brightcove embedded experiences. See the Overview: In-Page Experience Client API for more information.

The remainder of this overview deals with the REST API for managing your In-Page Experiences on the backend.

For a general introduction to In-Page experiences, see Overview: Creating, Editing and Publishing In-Page Experiences.

The sections that follow provide an overview of the 4 groups of REST API requests:

Experiences

Requests for Experiences fall into three sub-categories:

Manage experiences
These requests allow you get a list of all the experiences for the account. You can also create a new experience, and get, update, or delete a specific experience. Finally, you can duplicate an experience to create a starting point for a new one.
Publish/Unpublish experiences
These requests all to get a list of all templates for the account or a particular template.
Manage status for live experiences
These two requests allow you either get the current status of a live experience or change that status (from preEvent to live , for example).

Templates

Templates control the overall look and feel of an experience. Custom templates cannot be created, but there are several standard templates, and more may be added over time. The API allows you to get a list of templates available to your account, or to retrieve a specific template.

Themes

Themes allow you to customize a template to create the look and feel you want for your experience. The API provides methods to fully manage you themes, creating, getting, updating or deleting them.

Fonts

You can use your own fonts. These methods let you add fonts, update them, get them or delete them. These are web fonts, loaded via CSS.