Quick Start: In-Page Experience Platform (REST) API

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

The quick start provides examples of some of the API requests for managing In-Page Experiences, and provides a sample interface for using them.

Introduction

The In-Page Experience API allows you manage in-page experiences programmatically, making it particularly useful for CMS integrations, to allow users to create manage experiences from their own CMS instead of going to Gallery in Studio.

This quick start provides a sample implementation that allows users to:

  1. Get all in-page experience templates for an account
  2. Create a basic experience from the selected template
  3. Select either a playlist or list of videos to add to the experience
  4. Update the experience with the selected videos/playlist
  5. Publish the experience

Below is a high-level view of the app logic.

App Logic
App Logic

The app

You can find all the code for this app in this GitHup repository.

See the Pen Quick Start: In-Page Experience Platform API by Brightcove Learning Services (@rcrooks1969) on CodePen.

Using the CodePen

Here are some tips to effectively use the above CodePen:

  • Toggle the actual display of the player by clicking the Result button.
  • Click the HTML/CSS/JS buttons to display ONE of the code types.
  • Click Edit on CodePen in the upper right corner to fork this CodePen into your own account.
  • Find all the code associated with this sample in this GitHub repository.

Proxy code

In order to build your own version the sample app on this page, you must create and host your own proxy. (The proxies used by Brightcove Learning Services only accept requests from Brightcove domains.) You can download two versions of our proxy code: