Contact Us Get Email Updates
 
 

Thanks! Someone will be in touch with you shortly.

Rather just email us? Email us here.
Rather speak with someone in person?
Call any time with Tin Can questions:

866.497.2676

Download the Tin Can API Prototypes

When you download the prototypes, you have two options:

  • Run them on your local file system or on a web server and report statements to an LRS.
  • Zip the sample courses into Tin Can packages that can be imported into a Tin Can enabled system (such as SCORM Cloud.)

Run them locally, reporting statements to an LRS

There are three sample courses included in the download — a golf tutorial, a Tetris game, and a location-based tour of Nashville museums. You’ll find these courses in their respective folders.

To configure them to report statements to an LRS, you need to edit the config.js (rename it from config.js.template to just config.js). You’ll want to change the config file to contain the correct endpoint for the LRS and the actor name and email address. To report to the SCORM Cloud public LRS (viewable in the statement viewer and report sample on this site, or from the statement viewer and report sample in the index.html file you download with the prototypes), use this endpoint:

  • Config.endpoint = “https://cloud.scorm.com/ScormEngineInterface/TCAPI/public/”;

When reporting to the public LRS, you can ignore authUser and authPassword.

The actor line in the config file should look like this, with you replacing the email adress and the first/last names:

  • Config.actor = { “mbox”:["mailto:name@domain.com"], “name”:["First Last"] };

After you’ve set up the endpoint and the user info, run the index.html file and you can launch the courses or use the statement viewer to view statements.

If you’d like to send statements to your personal SCORM Cloud account, the steps are similar, except you’ll need some info from your SCORM Cloud account. Go to the Apps Section in SCORM Cloud and add a new app. Grab your App ID and Secret Key there, and plug those into your config.js file. For example:

  • Config.endpoint = “https://cloud.scorm.com/ScormEngineInterface/TCAPI/YourAppIDfromSCORMcloud/”;
  • Config.authUser = “ReplaceWithSCORMcloudAppID”;
  • Config.authPassword = “ReplaceWithSCORMcloudSecretKey”;
  • Config.actor = { “mbox”:["mailto:name@domain.com"], “name”:["First Last"] };

Run the prototype (index.html) and go through the activities. You can see statements in the statement viewer or report sample in the index file, or by logging in to SCORM Cloud and looking at the statement viewer in the Apps section.

Download Prototypes


Use the prototypes as Tin Can Packages

Tin Can still allows for the use of course packages, similar to SCORM packages. To see this in action, just download the prototypes and find the correct folder for the course you’d like to use. You’ll see the Golf Example course, the JsTetris game, and the Locator course. Navigate to the folder of the course that you’d like to use, and create a zip file out of its entire contents. (If you’d rather just have the Tin Can courses to import into your LMS, grab the Tin Can Golf Example and the Tin Can JS Tetris Tin Can package downloads).

You now have a Tin Can package that can be imported into any Tin Can enabled LMS. If you’d like a place to try it out immediately, sign up for a free SCORM Cloud account, import the course, and launch it. You can view the results of your activities in the statement viewer of your SCORM Cloud account.

Tin Can API Email Updates

* indicates required

Tin Can API Email Updates

Thanks for signing up for the Tin Can API newsletter!

Make sure to follow us on Twitter @ProjectTinCan,
and tweet this page to let others know about the Tin Can API.

Close