xAPI / Tin Can API guide
Marin Groothengel avatar
Written by Marin Groothengel
Updated over a week ago

⚠ Don't see this feature in your account? Maybe this option is not included in your plan. Contact us so we can help you further! Just send an email to info@hihaho.com.

This guide provides information about xAPI.

What is xAPI?

xAPI is also known as Tin Can API or experience API. It can be seen as the successor of SCORM.

Using xAPI, you can register so-called micro learnings, such as reading a book, attending a conference, or watching a hihaho video and store these results in a Learning Record Store.

What’s nice about xAPI is that you can also track the results of learning videos outside your Learning Management System. A typical example of using hihaho is sending a link to the interactive video by email. Your viewer can simply click on the link and the results are stored automatically in your LRS.

A nice introduction to microlearning and xAPI can be found on elearningindustry.com

How to enable xAPI

Go to the LMS tab on the Video Settings page.

Switch the ‘Enable xAPI’ toggle to Yes and fill in the Tin Can Endpoint, username and password. The endpoint of a Learning Record Store (LRS) is the link (URL) that handles all LRS requests. Type or copy the URL of your endpoint in this text field.

Finally, click on the button ‘Save’.

Frequently asked questions

How does hihaho register who has finished viewing the video?
When there is no known email address for the current user, he will be prompted to fill out his email address.

What commands does hihaho send through xAPI?
The video will send several commands through xAPI to your LRS. We use the ‘course’ and ‘video’ xAPI recipes. Learn more about xAPI recipes on https://tincanapi.com/recipes/.





I attempted a session for an elearning course

When the video plays for the first time, this xAPI command will be sent.


I answered an elearning course question

When an answer is given to a question, an xAPI command will be sent.


I completed a session for an elearning course

When the viewer has viewed the entire video, this xAPI command will be sent.


I passed an elearning course

When the viewer has scored more than the minimum percentage he needs to pass the video, this will be sent. You will find these settings next to the xAPI settings under the 'Reporting' tab.


I failed an elearning course

When the viewer has not met the minimum percentage needed to succeed, this will be sent.


Did this answer your question?