Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Approaches

  • Technical Specification for third party apps

    • Param Data Supported

    • Data Sharing Table

    • Summary Event Spec

    • API Documentation

    • Intent Handling

  • Vendor Registration of Apps to Sunbird

    • Global Vendor Registration API

    • Local Vendor Registration by Deep Linking

...

Expand
titleParams Data Supported

Params

Description

Data type

resourceId

identifier of the resource to be served in bazaar apps

String

collectionId

CollectionID of textbook,course

String

referrerPackageId

package details of referrer app

String

batchId

BatchId if it is trackable collection

String

mimeType

Content MimeType

String

vendorCode

Vendor ID to validate the referrer

String

contentCategory

contentCategory

String

artifactURL

Artifact URL to play content

String

telemetryContext

Hashed value of uid, sid

String

Expand
titleData Sharing Table

Params

Approach 1

Approach 2

Approach 3

resourceId

Yes

Yes

collectionId

Yes

Yes

referrerPackageId

Yes

Yes

Yes

batchId

Yes

mimeType

Yes

vendorCode

Yes

Yes

Yes

contentCategory

Yes

artifactURL

Yes

contentURL

Yes

telemetryContext

Yes

Yes

Yes

Expand
titleSummary EVENT Spec
Code Block
languagejs
{
  "edata": {
    "type": "", // Required. Type of summary. Free text. "session", "app", "tool" etc
    "mode": "", // Optional.
    "starttime": Long, // Required. Epoch Timestamp of app start. Retrieved from first event.
    "endtime": Long, // Required. Epoch Timestamp of app end. Retrieved from last event.
    "timespent": Double, // Required. Total time spent by visitor on app in seconds excluding idle time.
    "pageviews": Long, // Required. Total page views per session(count of CP_IMPRESSION)
    "interactions": Long, // Required. Count of interact events
    "envsummary": [{ // Optional
        "env": String, // High level env within the app (content, domain, resources, community)
        "timespent": Double, // Time spent per env
        "visits": Long // count of times the environment has been visited
    }],
    "eventssummary": [{ // Optional
        "id": String, // event id such as CE_START, CE_END, CP_INTERACT etc.
        "count": Long // Count of events.
    }],
    "pagesummary": [{ // Optional
        "id": String, // Page id
        "type": String, // type of page - view/edit
        "env": String, // env of page
        "timespent": Double, // Time taken per page
        "visits": Long // Number of times each page was visited
    }]
  }
}

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

...