Skip to main content

​
The test environment (this site)

Everything documented here - examples, the playground, your test API key - targets the test environment. It is the only environment you are given before go-live:
  • Synthetic data only. Test journeys are flagged end-to-end and structurally excluded from settlement, reporting, and clinician-facing queues.
  • Payments are test-mode only. Payment legs run in test mode; a test journey can never charge a real card.
  • Test patients carry TEST in their name. Use only invented test patients whose first or last name includes the uppercase word TEST (for example, last name TEST-Rivera).
  • Never use real patient data here. Use only invented patients whose names carry the TEST marker. Do not enter a real person’s name, date of birth, address, or health information in this environment, not even to try something out.
  • Test records are marked. Test-mode records are marked where they surface — a patient’s order view carries a Test order badge, and operator views mark test-mode records (with a banner on the onboarding view). The marking rides the individual record; there is no blanket watermark across every screen.

​
Test environment hosts

Read the API base from your welcome kit, which states it as PURPLE_API_BASE; the table above is what that value is in the test environment. The base is an origin only: the /v1 prefix is written into every path, so a full request URL is $PURPLE_API_BASE/v1/.... Your test API key ($PURPLE_API_KEY in the examples) is issued with your welcome kit, and it works only against these hosts. Custom sign-in domains are not live in the test environment. The login domain calls answer, but the CNAME target they return is a placeholder, and a login domain never serves here, even when its row reads active. Your patients sign in on the hosted sign-in page above. See Login URLs and domains.

​
Production

Production access is not available through this site. Production credentials, the production base URL, and any production playground exposure are a later, separately-gated step handed over at go-live - your onboarding contact owns that hand-off.

​
Versioning

The API is versioned under the /v1 path prefix. This reference is generated from the same contract artifacts the platform itself builds against, and it is published from the release the test environment runs: it matches the newest staging release. A change reaches this site when a release carrying it reaches the test environment, not before.