Adobe Primetime Authentication for QuickBrick TV Apps

Yonatan Gol
  • Updated
Follow

0Adobe Primetime Authentication(QB TV)

Version 1.0

 

Overview

Adobe Primetime is the gold standard authentication service for the TV Everywhere industry to accomplish the connection between the MVPD (multichannel video programming distributor) and the programmers (content owners) to verify a user’s entitlements.

 

Supported Platforms

 

Platform

Plugin Version

tvOS QB 

0.0.1

Android TV  v0.3.0

0.0.2

Samsung TV QB v0.3.0

0.0.1

Roku

0.3.0



Features

  • 2nd screen activation.

Standard paradigm used for Smart TV’s and connected devices instead of a traditional username/password login.

  • Authentication. 

This workflow activates the user device.

  • Authorization. 

Validates if a user has the entitlements to watch an specific content.

  • RSS Format. 

Allows to send content metadata to Adobe’s backend.

  • Customization.

The customer is allowed to change specific parameters of the UI. 

 

Prerequisites

The following parameters are provided through Adobe’s Console(Adobe’s documentation) and Adobe’s Developer Portal(http://live-adobe-pass.devportal.apigee.io/) are necessary to establish correct communication:

  • Base URL: Determines which Adobe’s Clientless API environment the plugin should use. The url for production: api.auth.adobe.com
  • Requestor ID: The ID assigned for the client by Adobe.

 

  • Resource ID: The ID assigned for the client’s resource by Adobe.
  • Public Key: Public API key issued by Adobe’s Developer Portal.
  • Private Key: Private API key issued by Adobe’s Developer Portal.
  • Registration URL: Url for the second screen activation page. This URL should not be a short or beautified URL as it is used as part of the QR Code generation process.

 

 

Note: Adobe’s documentation provides a quick guide on how to use their developer portal and acquire proper keys to communicate with Clientless API. Please refer to the following link.

Customers can use one set of keys for every TV platform yet Adobe best practices recommend to use a different set of keys for each platform using the Clientless API. Please always make the customer aware of this.



Adding the plugin to your application

1.- In the plugin configuration under the section Login you should see the plugin as follows:

mceclip0.png

2.- Click on the add button to confirm the addition.

 

Configuring the plugin

1.- After adding the plugin to your app you should see the section “Adobe Authentication Settings” on the right side of the plugin details page.

mceclip1.png

2.- Enter the values described in the Prerequisites section.

 

Important Notes

  • The Base URL should never be entered using the protocol of the URL. By default all calls to the endpoint use the HTTPS protocol.
  • A Software statement can be issued to cover several platforms or one in particular, please be sure to enter the one assigned to the platform in use.
  • There is the option to configure an “Authorization Default Error” which can be used as fallback when Adobe’s backend doesn’t provide an authorization error for a specific MVPD.

 

Adobe’s Screen and Personalization.

1.- Go to App Studio and select the layout assigned to your app version. Once in App Studio, add the adobe’s plugin screen to your layout.

mceclip2.png

2.- Select the screen added to activate the screen configuration section. Here you can personalize the UI for the Activation Code Screen. Colors and texts can be modified using the plugin configuration under the section screen design and text

mceclip3.png

3.- Please use the following schematic as reference:mceclip4.png

#

Component

  

Personalization

1

Instructions

Brief text to hint the user to go to the specific URL.
  • Text 
  • Font Size
  • Text color

2

Go To

Brief instructions about the purpose of the screen.
  • Text 
  • Font Size
  • Text color

3

Activation URL

Beautified URL for the activation page.
  • Text 
  • Font Size
  • Text color

4

Code Instructions

Brief text to hint the user what to do with the code.
  • Text 
  • Font Size
  • Text color

5

Activation Code

The activation code
  • Text 
  • Font Size
  • Text color

6

Additional Instructions

Text to present additional instructions if necessary. This text is optional and can be disabled.

*not available on Roku
  • Text 
  • Font Size
  • Text color

7

QR Code Hint

Brief text to hint the user what to do with the QR code.

*not available on Roku
  • Text 
  • Font Size
  • Text color

8

QR Code

QR code Image.

*not available on Roku

N/A

9

Background Image

Self explanatory.

Part of the uploadable assets



Staging Environment

Adobe Primetime Authentication allows customers to have different environments to manage and test MVPD’s integrations before deploying into production. Each environment has its own parameters to establish correct communication.

To configure the plugin to switch between adobe’s environments, the following parameters need to be changed accordingly:

    • Base URL.
      • Commonly the customer will switch to the staging environment. You can use the following URL:
        • api.auth-staging.adobe.com

 

 

* always review the latest documentation from Adobe link.

 

User Account Component

Adobe’s plugin is compatible with the user account component. This allows the user to login and logout using a settings section or the side menu of the application. To know more about the UAC please go to this link.

 

Comments

0 comments

Please sign in to leave a comment.