Embedding Synap
Integrate Synap into your LMS, website, or custom application.
Last updated
Was this helpful?
Integrate Synap into your LMS, website, or custom application.
Synap can run inside another application or website. This works even when your LMS or web platform is not listed under integrations.
We support several integration approaches. Speak with your account manager to choose the right one. They can also work with your technical team.
Most embedded integrations follow these steps:
Your application creates an iframe that loads a Synap URL.
Your backend generates a session token through the Synap API, or creates a JSON Web Token (JWT).
The token authenticates the user and opens Synap in the embedded view.
Never generate or sign tokens in client-side code. Keep API credentials and JWT signing keys on your server.
A JWT is a compact, signed token that securely carries identity information between systems. Synap verifies its signature before granting access.
JWTs let your application authenticate a user without asking them to sign in again. They can also include claims such as the user's email address, name, and portal context.
See JSON Web Tokens (JWT) for token requirements and setup instructions.
Synap can adapt its interface and behaviour for an embedded environment. This lets it operate as a child page within your application.
Depending on your integration, we can:
Hide primary navigation.
Delegate selected functionality to the parent application.
Pass results and other data back to the parent application.
This approach uses standard web security and interoperability practices. It remains flexible enough to support almost any platform.
The following are indicative examples of platforms where we have embedded Synap:
Moodle and Canvas
SuccessFactors and Thinkific
WordPress and custom-built systems
This is not an exhaustive list. Synap can integrate with practically any system that supports this approach.
Last updated
Was this helpful?
Was this helpful?