Sunbird Content Specification for Deep Linking

Intent

Need to create an unified deep linking 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 deep links as part of their implementation.

Approaches

Approach 1 : (Deeper Integration)

Deep Link 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

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

Tighter coupling for bazaar apps to be reliant on Sunbird APIs.

Necessary for bazaar apps to understand the content metadata. Could mean a development effort for these players

Any service disruptions,outage could spell trouble for these apps and also could potentially ending these apps taking a hit in terms of ratings.

Approach 1 : (Lighter Integration)

Deep Link provides basic information such as content do_id, telemetry context information & artifactUrl and mimeType.

Bazaar Apps can launch the artifactUrl directly based on mimeType.

Pros :
Least Effort in integrating the deep link for bazaar apps.

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

Approach 2 :

Sample Deep Linking Uri:
cpi://play?


resourceId
collectionId
referrerPackageId
batchId
mimeType
vendorCode
contentCategory
url