Introduction
Embed the Symptom & Illness Check App in your website or app.
The Symptom & Illness Check App is a pre-built app that embeds XUND's symptom checks and illness checks into your website or mobile app. The app shows the whole check itself, from the first question to the report, so you don't build any check screens.
The app uses the same medical engine as the Symptom & Illness Check API, so the API's Implementation Guidelines apply to it as well. For example, don't change, cover, or hide the content the app shows.
Two ways to embed
| Script embed | JS API | |
|---|---|---|
| How you add it | One <script> tag with attributes | Load the script, then call XUND.scic.init({...}) |
| JavaScript needed | No | Yes, a few lines |
| Language, profile data, starting check, onboarding, compact mode | Yes | Yes |
| Light, dark, or automatic colour scheme | Yes | Yes |
| Your own colours | No | Yes |
| Switch the colour scheme while the app runs | No | Yes |
| Action button on the report | No | Yes |
| Read the report data in your page | No | Yes |
Use the script embed for the quickest start. Choose the JS API when you need more customization or your page has to react to the check.
What you need
- Your Client Id, Web App Code, and API key — XUND provides them during onboarding.
- An auth code, created on your server for every page load — see Authentication.
- A container element with a defined height on your page — the app fills it.
Where to go next
- Authentication — create the auth code the app needs.
- Script embed — embed the app with a single script tag.
- JS API — initialize the app from your own script and read the report.
- Webhooks and your own identifier — link a finished check to your session, user, or other record.
- Parameters — every attribute and property in one table.
- Example apps — runnable PHP, .NET, and Android projects on GitHub that embed the app.
Last updated on