How to get started with the SCORM Cloud API

 

1. Sign up for a SCORM Cloud account

This is where your SCORM content will be hosted, played and tracked once the integration with the API is complete. Your SCORM Cloud account comes with an AppId (short for Application Id) which is how our web service identifies your account. You’ll need this AppId (and the Secret Key that comes with it) to connect your environment to your SCORM Cloud account.

2. Download the code

You’re free to code directly with our API, but we have some some libraries to make it easier for you — Java, .NET, PHP, and Python. There’s also a community-managed Ruby on Rails library. (Want to start your own community-managed library? Let us know, and we’ll help!) Links to the libraries are available below, and each has information to get started with them specifically.

3. Download a Demo Application

To help get you started, we have provided Demo Applications to show you the primary functionality of the API — specifically how to import, register, and launch your content in SCORM Cloud. Links to the applications are available below, and each has information to get started with them specifically.

4. Initialize

Once you’re ready to use the library in your application, you need to make sure it is configured when your application initializes. This is where the AppId, SecretKey, and Services Url for the client library is set so that it knows where to access SCORM Cloud services and what account to access them under. Once the library is configured, you can start calling methods and interacting with SCORM Cloud.

What can you do with the SCORM Cloud API?

Here are some basic calls you can make to SCORM Cloud:

  • Import: Upload your course directly to SCORM Cloud.
  • Create Registration: Once the course is imported, you can use the course ID to create registrations for the course.
  • Launch Registration: Once a registration is created for the course, you can launch that registration by redirecting the user’s browser to the course location in SCORM Cloud. You can also specify where the user goes once they exit the course.
  • Fetch Registration Results: You can easily get the “big four” registration results (completion, success, score, total time) and save the summary data into your own local database. You can access the Reportage API or use widgets and embeddable reports for even more data.

 

If you have questions about what you can actually do with the SCORM Cloud API, see our FAQ page here.

 

 
 
 
 
 
 

A simpler way to deliver e-learning.

SCORM Cloud lets you deliver training where your learners live.




Try it Free