Environments
Two environments, fully separate. The credential decides which one a request belongs to; a key presented to the other is refused with environment_mismatch (403).
| Sandbox | Production | |
|---|---|---|
| Base URL | https://sandbox.trueroute.health | issued with your production credentials after approval |
| API key begins | tr_sandbox_ | tr_live_ |
| Data | synthetic only; never a real patient | real clinics and real patients |
| Keys come from | a developer account (coming soon); until then, on request | TrueRoute only, after approval, a signed agreement and sandbox certification |
| Extra routes | the sandbox advance route can play a whole lab journey (result, correction, critical value) | none: sandbox-only routes are never mounted |
Is a deployment enabled?
curl -s "https://sandbox.trueroute.health/health/enterprise"No credential needed. A deployment that has not enabled the partner API answers 404 on every partner path.
Sandbox rules
- Use synthetic data only. Never send a real person's record to the sandbox.
- Sandbox keys cannot be used on production, and production keys can never be created from the sandbox.
- Rate limits and body limits are the same as production (rate limits).
Going to production
- Build and certify against the sandbox.
- Sign the agreement (and, where patient data flows, a business associate agreement).
- TrueRoute approves the integration and issues production credentials, with the production base URL, through a secure channel. Production keys are never shown on this site or issued from a dashboard.