Contact Support | System Status
Page Contents

    Overview: Brightcove Beacon Web Store

    This topic provides an overview of the Brightcove Beacon Web Store service.

    Introduction

    The Beacon Web Store is a configuration, features and API integration that enables Beacon licensees to implement subscriptions, in Bring Your Own (BYO) web stores. The content owners implement the store front and business logic for renting and selling and the payment system integration in the web store. An Beacon API provides the interface for the store to add, remove and edit the resulting entitlement changes within the Beacon CMS. The logic defining access and display of the content titles in Beacon apps is unchanged.

    Implementation of all financial reporting, dashboards, and tax payment are not managed or tracked in Beacon and are the responsibility of the Content Owner.

    Glossary of terms

    The table below explains terms used in this topic.

    Glossary of Terms
    Term Explanation
    Web Store A BYO commerce website for selling, renting and selling subscriptions
    Payment processor A system used by the web store to process transactions and deposit revenue into an account
    SKU Identifier for Beacon Assets
    SVOD Subscription VOD, recurring payment model
    Plan An SVOD offer definition
    UMS User Management System
    Proxy UMS Proxy copies of users that map to master copies in BYO UMS. Beacon entitlements are managed in the Proxy UMS system.
    OIDC Open ID Connect, a protocol to communication Authorization during Authentication
    Authentication Identification of specific users for the purpose of granting access
    Authorization Communicating user entitlements via tokens upon login
    In App Purchase (available in Q2 2021) For cases where customers are adding Beacon apps to their web store product offers, and wish to sell the new product configurations through app stores, Beacon Stores can be configured for in app purchase.
    Entitlements Access to Beacon content or features
    Purchase Notifications A message, sent from a Beacon store to Beacon CMS that indicates a change in purchase status (purchase, cancel) of a subscription or asset rights
    Connected TVs HDMI connected external devices that provide app management support to televisions: Apple TV, FireTV, Roku, and Android TV STBs
    Smart TV Televisions with built-in support for app management

    Beacon Store components

    All Beacon Store purchases are made through web stores. The selling model requires Viewers to visit the customer web store, purchase content and then open Beacon apps on their supported devices as a separate action.

    The required components are:

    Beacon Store Components
    Component Responsibility Description
    Web Store Content Owner A user provided web store that implements the logic and process for selling and renting access to individual content titles and renewable subscriptions.
    Payment Processor Content Owner A system for processing payments for items sold through the web store. This service will transact credit card debit card, e-wallet, and QR code payments in local currency and settle with the bank of the content owner.
    User Management System Content Owner A User Management System must be provided for storing records of registered users. The owners of existing web stores will want to maintain their existing UMS since it contains all of the historical information about their customers.
    Brightcove Beacon Brightcove Brightcove Beacon provides configuration and packaging of content into named SKUs that are sold on the web store and the Beacon Entitlements API where the web store registers entitlements for specific content access rights in viewer records.
    Entitlement Notifications Brightcove and Content Owner The Webstore sends notifications of commerce events such as subscription purchase or cancellation to Beacon and Beacon updates the user entitlements to Beacon assets in the Beacon UMS.

    Beacon Store Workflows and Configurations

    You may well have already had a commerce web sites as an integral component of their businesses prior to introducing Beacon and want to add Beacon subscriptions to your web store products. The web stores consist of three components:

    1. Web store - The web store is your organization’s commerce site. It presents the products, pricing and purchase models.
    2. Payment processor - The payment processor is a system that processes transactions, accepting payment from credit cards, debit cards and e-wallets, deposits the payments in the organization’s bank account and sends receipts to the purchaser.
    3. User Management System - Your organization maintains a list of their registered patrons in their UMS.

    The Beacon Store integration has two development activities

    1. Beacon receives notifications of financial transactions from the web store - Sales and cancellations of Beacon subscriptions from the web store are reported to a Beacon API. Beacon adds or removes entitlements based on these notifications.
    2. Connect and synchronize the Beacon and Web Store User Management Systems - The Webstore UMS user record contains the master record and the user and is the source of stored user data. Proxy users are created in the Beacon UMS for each of the registered patrons. Beacon assigns entitlements to the proxy user record upon receiving transaction notifications. Changes in the store UMS such as adding and deleting users are applied to matching user records in the Beacon UMS.

    Beacon Store Configurations

    Beacon Stores are pre-existing, customer owned and operated BYO web stores that are integrated with Beacon for the purpose of adding Beacon subscriptions to the list of products sold on the web store. Arts organizations provide an example illustrating the two primary selling models for supporting this objective.

    Arts organizations currently sell subscriptions, tickets and physical merchandise related to performances through their web stores. Therefore, there are existing web stores, user management, payment processing and entitlement tracking systems in place to manage that commerce.

    Some organizations have decided to expand their audience by including virtual access to these same events as well as recorded content. They further want to consolidate the entire commerce management process within their web stores.

    A subset of organizations want to achieve the same result with their web stores, and want to sell those same products as in app purchases in the app stores (Apple Store, Google Play, Amazon, Roku and the Stripe integration with the Beacon Web app).

    Web Store Only Purchases

    Web store only workflow is implemented as shown in Figure 1. The customer brings their own web store, payment processor and UMS. The integration points are:

    • UMS Proxy Users - The full records of the registered users are maintained in the customer’s BYO UMS and that is the source of truth for user account and account management of the user. User authentication on login occurs in the BYO UMS. Proxy users are created in the Beacon UMS upon authentication or subscription. When users are deleted from the UMS, proxy users are also deleted from Beacon.

      The synchronization for authentication and account management is accomplished using OIDC (Open ID Connect) protocol, an extension of OAuth 2.0. You must either provide a system with native OIDC support or update your UMS interface to support OIDC.

    • Purchase Notification - The web store is modified by you to send notifications of Commerce Events to the Beacon Entitlements API. The notification includes the USER ID and PRODUCT SKU. When Beacon receives the notification the appropriate update to the entitlement in the User record is recorded in the Beacon UMS. Thus bestowing or revoking the entitlement that enables the user to view content in Beacon apps. The technical Entitlements API interface is defined in Beacon Integration Details
    Beacon Store
    Beacon Store

    Configuration details:

    • The subscription definitions in webstore and Beacon MUST be configured with the IDENTICAL SKU names.
    • The web store notifications are sent to a web hook URL that is presented from the Beacon CMS.

    Beacon Store with In App Purchases

    The Web store within the app purchase workflow is implemented as shown in Figure 2. In this model, in app purchases can be made from the Amazon, Apple, Google and Roku stores and the your web store. You are responsible for:

    • Your own web store
    • The payment processor
    • The UMS
    • Merchant accounts at the required stores

    Brightcove Beacon provides the in app purchase integrations. The integration points are modified from what is described in the previous section to include payment notification FROM Beacon TO the webstore of successful in app purchases that occur. The notification messages generate by Beacon follow a similar schema.

    Beacon Store with In-App Purchases
    Beacon Store with In-App Purchases

    Configuration details:

    • The subscription definitions in webstore and Beacon MUST be configured with the IDENTICAL SKU names.
    • The web store notifications are sent to a web hook URL that is presented from the Beacon CMS.
    • Beacon communications are sent to a webhook URL that is presented from a service of the your choosing.

    User Management Systems

    The typical use case for Beacon stores is the integration of Beacon with a pre-existing, established web store. Less common is the launch of a new service with a new web store for managing commerce.

    Externally Connected UMS

    Pre-existing web stores are always integrated with user management and payment processing systems. In this case, your goal is to integrate Beacon within the pre-existing commerce configuration. Your UMS will remain the point of authentication and user record management. Therefore, the integration will use the customers UMS to authenticate and Authorize Beacon users. The user’s email address is used as the account ID and the entitlements are associated with that account. All user personal information data is stored in the BYO UMS.

    External BYO UMS systems interface with Beacon using the OIDC interface protocol. Open ID Connect is an extension to OAuth that standardizes identity token schemas.

    Mobile and Web UMS Configuration

    Mobile and Web UMS
    Mobile and Web UMS
    1. User selects to login in Beacon App
    2. App interacts with the OIDC provider to guide users through login flow. On success, access, refresh and identity tokens are provided to the app
    3. App uses access token to connect to Beacon backend
    4. Beacon backend validates access token

    Connected and SmartTV UMS Configuration

    Connected and SmartTV UMS
    Connected and SmartTV UMS
    1. User selects to login in Beacon App
    2. App requests a device code
    3. User goes to Mobile or web device, enters authentication URL and device code
    4. Device interacts with OIDC provider to authenticate user
    5. Connected or Smart TV continuously poll the OIDC provider to find out if user authenticated, when authenticated, access, refresh and identity tokens are provided to the app
    6. App uses access token to connect to Beacon backend
    7. Beacon backend validates access token

    Beacon User Management Autosync

    When integrating an existing UMS with Beacon, proxy users must be created in the Beacon UMS so that entitlements created by Beacon Store sales notifications can be assigned to the proper user.

    Users are maintained in Beacon as a result of events in the customer’s UMS. Through the OIDC interface, users are created in Beacon when they authenticate in the external UMS or if an entitlement is sent to Beacon. No manual synchronization is required.

    Beacon Store Monetization Models

    Beacon Stores are configurable to support SVODtransactions. Configuration details:

    SVOD configuration

    Beacon configuration

    1. Create an SVOD Plan in Beacon
    2. Set state to UNPUBLISHED in Beacon
    3. Define a SKU for the plan in Beacon
    4. Assign content to the plan

    Web store configuration

    1. Create an SVOD Plan/product in the web store and web store payment system
    2. Give the play the same name as that used in Beacon
    3. Copy the SKU from Beacon into the SKU ID in the web store payment system

    Page last updated on 18 Apr 2021