Overview
Before any of the Pearson SCORM Services APIs can be used, there are a number of steps that must first be carried out.
All above steps are accomplished using the Pearson SCORM Services - Control Panel. |
| Create Account | Create Consumer | Associate SubPub Subscription |
|---|---|---|
 |
 |
 |
Create Account
This step will normally be carried out for a new customer/integrator by a Super Administrator as part of the onboarding process for the new customer/integrator.
Create Consumer
The SCORM Player is factored as an IMS Learning Tools Interoperability (LTI) remote LTI Tool Provider. Systems that use LTI Tool Providers are known as LTI Tool Consumers. The web application that is ownned by the new customer/integrator, typically a Learning Managament System, will need to be registered with the Account as a new Consumer.
When the new Consumer is created a new public key and private secret are created for the Tool Consumer:
- The public key uniquely identifies the Tool Consumer to the Pearson SCORM Services Platform.
- The private secret is used to secure requests from the Tool Consumer to the Pearson SCORM Services Platform.
Create Eventing Subscription with Call Back URL
Pearson SCORM Services uses Pearson Eventing (aka SubPub) to communicate back the status to consumer in an asynchronous way for POST Cartridge API and DELETE Cartridge API requests made by the consumer. Pearson Eventing works based on eventing model where publisher can publish an event to a queue. One or more subscribers can subscribe to the event. Once the event is received by Eventing, it notifies all the subscribers who have subscribed to that event.
Pearson SCORM Services plays the role of publisher which publishes the events to Eventing. The consumers of Pearson SCORM Services plays the roles of Subscriber. As part of on-boarding process, the consumers of Pearson SCORM Services have to provide a Callback URL. Using the Callback URL provided by the consumer and unique public key created in above step, an subscription is created in Eventing system using Eventing API's.
Pearson SCORM Services publish the status of API requests as events to Eventing. Eventing system notifies the consumer by making HTTP POST to the Call Back URL with key value pairs.