By default, learners access courses through the HowToo platform. With iFrame embedding, you can display those same courses within your own environment, such as your website, intranet, or learning portal.
This allows your learners to stay within your platform while still accessing HowToo content securely.
With this feature, your learners can:
- Retrieve a list of published Academy courses from your Learning Academy
- Search and browse available courses with ease
- Display course content directly within your own website or portal
- Launch courses securely using a token-based link
- Control access so only authorised learners can view the content
- Provide a seamless experience without learners needing to leave your platform
- Show clear error messages if access requirements are not met
Who can use this feature?
đź‘€ Creators, primary admins, and admins
🏳️ Available on all plans, additional functionality available on Professional plans.
Contents of this article:
- How is iFrame shown in your platform
- What are the access requirements
- How to embed iFrame in your platform
This guide shows you how to embed and display HowToo Academy courses within your own platform.
How is iFrame shown in your platform
You can choose how courses are presented within your platform, depending on your design and learner experience goals.
- Display the course inside an iframe on a webpage
- Display the course inside a modal using an iframe
- Open the course in a new browser window or tab
- Display the course as a full-page experience within their own portal
These options allow you to tailor the experience to best suit your platform and your learners.
❗️ Note: While organizations can choose how the course page is presented, lessons launched from the
course will open in a new browser window.
What are the access requirements
For the learner to access an embedded course, all of the following conditions must be met:
- The token is valid
- The course exists
- The course is published
- The course belongs to the correct organization
- The learner is enrolled in the course
- The learner is active
If any of these conditions are not met, the learner will not be able to access the course.
How to embed iFrame in your platform
A new embedded course page will be available at the following path: /embedded/course/{publishedCourseId}
The embedded course experience should follow this flow:
- Call https://<site>/v1/courses to retrieve a list of published courses available in your organization's Learning Academy.
- Render the returned courses on the page so the learner can browse or search available courses.
- When the learner clicks a course in the list, call https://<site>/v1/launch with the learner’s email address.
- Use the token returned in the /v1/launch response to generate a secure course access URL.
- Construct the embedded course URL in the following format:
https://<site>/api/v1/auth/callback?token=
<token>&redirect=/embedded/course/{publishedCourseId} - Present the generated URL in the organisation’s preferred format:
- inside an iframe
- inside a modal using an iframe
- in a new browser window or tab
- as a full-page experience within the organisation’s portal
This flow ensures the learner’s access is validated before the course is displayed.
Comments
0 comments
Please sign in to leave a comment.