> For the complete documentation index, see [llms.txt](https://academy.synap.ac/doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.synap.ac/doc/integrations/embedding-synap.md). # Embedding Synap 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. ### Common workflow Most embedded integrations follow these steps: 1. Your application creates an `iframe` that loads a Synap URL. 2. Your backend generates a session token through the Synap API, or creates a JSON Web Token (JWT). 3. 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. ### JSON Web Tokens 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)](/doc/portal-settings/portal-settings/sso-authentication/json-web-tokens-jwt.md) for token requirements and setup instructions. ### Embedded mode 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. ### Example integrations 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. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://academy.synap.ac/doc/integrations/embedding-synap.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.