Guides
Guides
Task-oriented walkthroughs covering the integration path from the first API call to a production launch.
These guides walk you through the integration in the order you'll actually build it — from the first authenticated call to the production checklist.
- Your first check — from zero to a finished report, with a runnable script you can execute against the live API.
- The question-answer loop — the state machine your code must implement: question types, answer shapes, and the
FUNCTIONquestions that interrupt the loop. - Advanced question UI —
detailedTypeanddetailedTypeData, specialized widgets versus the generic fallback, and paging or searching large option lists. - Changing answers and recovering state — stepping back to earlier answers and rebuilding a check after your client loses its state.
- The overview — fetching, editing, and confirming the overview, and the 403 error (
OVERVIEW_CAN_NOT_BE_SKIPPED) you hit when you skip the fetch. - The report — fetching the report as JSON or PDF, which ends the check, and the history endpoints for finished checks.
- Displaying the report — how XUND's own reference integration renders each report field (score, urgency, treatment advice, warning signs), and why following it is the safe default for the acceptance test.
- Lookups — the read-only endpoints outside the check flow: Content Library, Medical Services, and Specializations.
- Webhooks — get notified on your server when a check finishes, and verify each request.
- Error handling — the error codes the API returns, what triggers each one, and how to recover.
- Going live — the compliance and operational checklist for moving from prototype to production.
Last updated on
Implementation Guidelines
Non-negotiable rules for integrating XUND as a certified medical device: content integrity, consent, imprint, checkflow rules, and age-gating.
Your first check
Go from credentials to a printed symptom check report with a single dependency-free Node.js script, in about 10 minutes.