Pearson
Always Learning

As a developer, you have a variety of integration options based the features of your application. Summarized within this section are the details for each.

Course Exam Selection Interface

The first part of the integration is allowing the instructor to choose which exams require ID verification. There is nothing required of the third party provider for this part.

To integrate the selection interface into a LearningStudio course, the instructor (or instructional designer) should create a Text/Multimedia content item, and using the Visual Editor’s HTML mode, use the following code as the only content for that item.

Important: The content item should be hidden from students.

<script type="text/javascript">
<!--//--><![CDATA[// ><!--
 
<!--//--><![CDATA[// ><!--
 
function OpenDashboard(){
    window.open("http://idverification.next.ecollege.com/Dashboard/Dashboard.ed", "_new");
}
OpenDashboard();
 
//--><!]]]]><![CDATA[>
 
//--><!]]>
</script>

Student Registration

If your application requires that users first register for an account, this is facilitated with an Outbound SSO to your application as described in this section (Note: LTI integrations are always the most preferred). The key data points that are passed to you are the user’s ID and the institution’s client string. These two values will also be passed within the exam interrupt and can be used to look up the user in order to join the two processes within your application.

Exam Interrupt (Outbound to Identity Provider)

When a student accesses an exam that requires ID verification, the student will be redirected to your application. The message we send you will be encrypted using AES encryption (in combination with a shared, secret salt value). The encrypted string will be base64-encoded prior to being sent to sent to your application.

When you receive the SSO request, do the following:

  1. Base64 decode the incoming string
  2. Decrypt the AES string using the passphrase, vector and salt value you were provided for your integration.

For example, we would redirect to your application with this URL structure:

https://www.your-website.com/incoming?args=eDJqcDVMbm1TY0hJbkVQMjI4enVwSXdWZ25ncGtuT01GOEF4T3NJb3pyK0ViT2QvdEF1eVF3L3hFbVlyWVRTeHE5d09FNlpmdWV0dWJYMjk5K0xZV1hyVjdIb3BTeXBVenRIbnNQdFpQNG9mRjRLd3BtRXBNdjJBekI3NFZrbW82MCt4b2w3MlhCSWhLOHdDcjh0U1dRPT0=

After you base64-decode and decrypt the args parameter, the plain-text version of that request would look something like:

https://www.your-website.com/incoming?args=ts=11/1/2013 9:42:22 PM&amp;srcid=Pearson&amp;appid=IDCheck&amp;cst=ciu&amp;uid=467613&amp;em&amp;jsmith@email.com&amp;coid=4563218&amp;ciid=99563218&amp;ses=http://idverification.next.ecollege.com/(NEXT(c62ac58cd8))/IDVerification/IDVerification.ed

A description of these parameters is available on the Data Points page.

Inbound Request Back Learning Studio After Identity Verification

Once a user has completed their identity verification attempt in your application, you will redirect them back to LearningStudio. At that point, the institution will either allow access to the exam or not, depending on their settings in LearningStudio.

For outbound requests back to LearningStudio, you will simply do the inverse of the decryption steps in the previous section:

  1. Encrypt the AES string using the passphrase, vector and salt value you were provided for your integration.
  2. Base64 encode the outbound string
  3. Redirect the user’s browser to that URL.

An example of the an outbound request from your application back in to LearningStudio could be as follows:

http://{url}?args=rDwcDVMbm1TY0hJbkVQMjI4enVwSXdWZ25ncGtuT01GOEF4T3NJb3pyK0ViT2QvdEF1eVF3L3hFbVlyWVRTeHE5d09FNlpmdWV0dWJYMjk5K0xZV1hyVjdIb3BTeXBVenRIbnNQdFpQNG9mRjRLd3BtRXBNdjJBekI3NFZrbZ90MCt4b2w3MlhCSWhLOHdDcjh0U1dRPT0=

Note the value to use for {url} is provided when SSO to your application. See Data Points.

When we decode and decrypt the URL, we expect to see something like this:

http://{url}?args=ts=11/1/2013 9:42:22PM&amp;appid=IDCheck&amp;octm=true&amp;msg=Please+contact+the+support+team+for+
further+details

Campus Admin And Instructor Reporting Of Results

LearningStudio does not store the identity verification results, the framework only uses the value in session to determine the routing logic to apply for the given student/campus combination. Therefore, your application should provide a reporting feature so that campus administrators (and ideally instructors) can review results of student identity verification results.

It’s also recommended that you provide an SSO pathway that can be used in courses so instructors can view the report. This isn’t required, and it isn’t required it be unique from the other SSO links to your application. Our SSO systems provide user role information so you can determine an incoming user is an instructor and show them a instructor-specific user interface.

If choosing to develop a reporting interface for authorized users, you will also leverage the Rest based services that are documented within this site to make the necessary call backs to retrieve the additional data points so users can have the necessary reference information displayed to them.

For example, the exam interrupt framework will pass to your application the user ID of the user accessing the exam and the content item ID of the exam they launched out from. These two data points alone will not provide enough meaningful context to instructors when viewing the data. (User IDs are not displayed in LearningStudio’s interface). It will be helpful to augment this information to pull in things like the term name the course resides in, the course information the exam is in (course title, display course code), the unit name the exam is in within the course and the content item name for the exam.

A sample of the API calls to pull in this context is outlined below -

2096 reads
Always Learning
Pearson