TVkey activation with SSO

Overview

TVkey allows you to develop your own application to run on modern Samsung smart TV sets without a set-top box.

This section is only relevant if you are developing your own application. If you are using NAGRA's ION application for Samsung TVkey smart TVs, it is not required.

This section explains how to activate a TVkey device when SSO is used.

It only covers the activation flow. For the main TVkey documentation, see TVkey Cloud Integration.

In the non-SSO scenario, you activate a TVkey device by calling the appropriate SSP endpoint(s). See TVkey Cloud Integration.

The client requests described here are generic. However, some integration work will be required, depending on the authentication provider used. Please contact your NAGRA representative for more information.

End-to-end flow

1. When the TV is used for the first time, as part of the initial setup process, the TV will:
   1. Look for TVkey-enabled apps in the Samsung store for the selected locale.
   2. Present all such apps so the user can decide which (if any) to install.

   3. If the user selects an app, download and run the installer.

      

      There is also an option to provide an installer app that does not install a full application. Instead, it contains metadata that allows the user to access the operator's channels through the Samsung built-in EPG.

      This allows faster time-to-market while a full app is being developed.

2. The installer app:
   1. Prompts the user for their sign-on credentials (username and password) for the operator's SSO service.
   2. Calls the the TVkey Cloud Client (that is, the device itself) to get the TVkey challenge.

   3. Calls the Authentication Gateway Service (AGS) to activate the device, passing it the challenge from the previous step. (See Activation flow below.)

   4. Makes a device activation request to the TVkey Activation Proxy (TKAP).
   5. Installs the operator's application (the "supervisor app").
   6. Runs the supervisor app.
3. The supervisor app:
   1. Signs on using the /ias/v3/token/actions/signOnByTVKeyActivation endpoint. (See the Identity Authentication Service (IAS) API documentation.)
   2. Presents its UI to the user.

Activation flow

The activation flow consists of the following main steps:

1. Getting SSO services (in the main SSO section)
2. Activating a TVkey device with SSO. This can result in one of two successful outcomes:
   • Only one matching OPF account is found. The device is activated and associated with this account.
   • Multiple matching OPF accounts are found. In this case, the application must:
     1. Prompt the user to select the account to use.
     2. Activate the device for the selected account.