You will be provided with a list of courses including their URLs. The URLs can be embedded in your Learning Management System (LMS) or Membership Management System (MMS) however you see fit.
To launch and track the course, we will need you to provide information about the user taking the course in the query string of the course URL. Information about the query string parameters is provided in the documentation.
Your users will launch and complete the course without having to leave your system or create an account on another system.
All of your users’ completion data is reported back to you via Activity Progress API or Webhook.
Typical Use Case
Below is a typical use case example to assist with your implementation.
User clicks the “Start” course link for the first time (your system generates a new, unique registration (UUID) for this course instance as well as passes the other query string parameters).
User ends the session before completing the course.
User returns and clicks the “Start/Resume” course link (your system should reuse the same UUID as well as pass the other query string parameters).
User is able to resume the course from where they left off earlier.
End User Support
Your organization will be responsible for handling user support for questions related to your system. Examples would be issues signing in, forgot password, and technical questions as they relate to your system. Users that have questions or difficulties with the course itself should:
Review the course FAQs by clicking on the help icon.
If the FAQs do not provide resolution, users have the option to contact the course help desk.
Course Launch Query String
To launch courses from your LMS or MMS you will need to append a query string to the provided URL(s). This information is required to launch the course and track user progress. The query string appended to the course URL must be uniquely constructed by your system for each user.
When appending query string data to the course URL, it must come after “/#/”.
Uniquely identifies a user’s instance of an activity. This value is generated by your system and must be unique for each user’s instance of an activity (it is unique to the user and the activity). This value should NOT be regenerated each time a users launches a course.
This is the domain that you are launching the activity from. Please include subdomains
The value is provided in the documentation for the system you are integrating with.
Course Lists & LMSID
To find the course list and LMSID for the system you are integrating with:
Select the system you are integrating with, and
Find the section for the Course API info.
Make sure you are using the staging course URL when you are testing your integration.
Make sure you are using the staging LMSID when you are testing your integration.
Make sure you are using the production course URL for your production environment.
Make sure you are using the production LMSID for your production environment.
This API is commonly used in conjunction with:
You can request Courses API access using the form below.
Please make sure that you have submitted the Sign-Up Form prior to completing this provisioning request.
All integration-related support requests should be sent to firstname.lastname@example.org.