Sunbird Content Specification for Bazaar Apps

Intent

Need to create an interface for enabling Access to Content on Sunbird across different apps like Read Along,Games etc.

Note: Assumption of this specification is based on the apps being able to support these intents as part of their implementation.

Documentation is categorised into multiple sections:

WorkFlow
Vendor Registration of Apps to Sunbird
- Global Vendor Registration API
- Local Vendor Registration by Deep Linking
Technical Specification for third party apps
- Param Data Supported
- Summary Event Spec
- API Documentation
- Intent Handling
Approaches

Work Flow

Registration of External Apps

Global Registration

{
  identifier: "",
  name: "",
  logo: "",
  appName: "",
  packageId: "",
  target: {
    mimeType : [],
    contentType : [],
    .... // All content attributes
  },
  appDetails: {
    organization: ""
  }
}

Local Registration By Deep Link (Only Restricted to that particular device)

Registering by Deep link inside Sunbird

sunbird://register?name: "Google Corporation", logo: "https://<domain-url>", appName: "Google Bolo", packageId: "com.google.bolo",target:”{}”,appDetails:”{}”

Sunbird Third Party App Interaction

{
  referrerPackageId : "com.google.bolo",
  referenceID : "App generated Code",
  mimeType : "",
  vendorCode : "",
  contentUrl : "",
  profileContext: "{handle:'',avatar:''}"
}

{
  "edata": {
    "type": "", 
    "mode": "", 
    "starttime": Long, 
    "endtime": Long, 
    "timespent": Double, 
    "pageviews": Long, 
    "interactions": Long, 
    "envsummary": [{ 
        "env": String, 
        "timespent": Double, 
        "visits": Long 
    }],
    "eventssummary": [{ 
        "id": String, 
        "count": Long 
    }],
    "pagesummary": [{ 
        "id": String, 
        "type": String, 
        "env": String, 
        "timespent": Double, 
        "visits": Long 
        }]
    }
  }

Vendor registration of Apps to Sunbird

Global Vendor Registration API

Each Vendor can be registered as part of Global Configuration for Sunbird to have app links being enabled.

Vendor CRUD API (or) Form Configuration Supported.

Local Vendor Registration by Deep Linking
Enabling of Deep link in Sunbird for local registration restricted to device.
Device hears for deep links to register vendor apps locally (Restricted to particular device).
Steps
- Vendor app needs to call a deep link of Sunbird app.
- Sunbird App as part of handling deep link will try to persist vendor information locally on app’s data.
- Any subsequent invocation of intent from Sunbird will show globally registered apps for Sunbird along with locally registered apps in devices.

deeplink Url :

sunbird://register?name: "", logo: "", appName: "", packageId: "",target:”{}”,appDetails:”{}”

Parameter	DataType	Description

Parameter	DataType	Description
name (M)	String	Name of the vendor
logo (M)	String	App logo Url
appName (M)	String	App Name
packageId (M)	String	PackageID of the app
target (M)	String	Targeted content query
appDetails (O)	String	App details
extra (O)	String	Misceallaneous Information to be sent

Approaches

Approach 1 : (Deeper Integration)

Intent provides basic information such as content do_id, telemetry context information.

Targeted Application need to fetch the data from platform. Understand the Content Metadata and play the content.

Targeted Application need to respond back with Summary Data

Params	Description

Params	Description
resourceID	Content ID of the resource
context	Context of the play - like did, sid, uid etc

Pros

It can enable bazaar apps to index the content in their own environment.

It could open up the Sunbird APIs for most of the bazaar players.

Cons

Data to be sent might be huge

Spec is rigid. If the spec changes there can be inconsistency between various version of both apps

Approach 2 : (Lighter Integration)

Intent provides basic information such as content do_id, context information & artifactUrl and mimeType.

Bazaar Apps can launch the artifactUrl directly based on mimeType.

Params	Description

Params	Description
resourceID	Content ID of the resource
context	Context of the play - like did, sid, uid etc
mimeType	Mime type of the content
artifactUrl	The URL to download the content

Pros
Least Effort in integrating the Intent for bazaar apps.

Need to develop a secure mechanism to serve only sun bird specific resources.

Cons

Data to be sent might be huge

Spec is rigid. If the spec changes there can be inconsistency between various version of both apps

Intent provides the basic information such as content URL, mimeType & user/session context.

Params	Description

Params	Description
resourceID	Content ID of the resource
context	Context of the play - like did, sid, uid etc
mimeType	Mime type of the content
contentUrl	The public Sunbird content url or a dial url (https://<domain>/content/v1/read/do_xxxx => https://<domain>/dial/XC40VV)

Pros

The spec doesn’t need to change if more content metadata needs to be sent
The integration apps need to understand our content model and can also index the content in their apps

Context Information

Following are the contextual params passed to the reader app

Device ID
User ID
Session ID
Collection ID
Batch ID
Reference ID

Technical Specification for Third Party Apps

Params	Description	Data type

Params	Description	Data type
referrerPackageId	package details of referrer app	String
referenceID	Reference ID to be sent back to sunbird app	String
mimeType	Content MimeType	String
vendorCode	Vendor ID to validate the referrer	String
contentUrl	Url of the Content	String
profileContext	Name and Avatar	String

https://github.com/sunbird-specs/Telemetry/blob/main/v3_event_details.md/#summary

All the reader apps need to send summary data back to Sunbird app via intent data.