There is an option to conduct development, testing, and debugging in the sandbox environment. This allows you to connect to the Ornament API for free and fully debug the integration before launching in the production environment.
Automatic digitization of uploaded lab reports is not available in the sandbox environment. Images and PDF files submitted here will not be processed automatically.
For testing purposes, you can use the pre-digitized sample files provided at the links below. After uploading these samples in the sandbox environment, digitized results will be available.
Test samples of lab reports
To use the sandbox environment, you need to create a separate account on the sandbox version of the website https://sandbox-pro.ornament.health/app/ and obtain an API key there.
To connect to the sandbox version of the API, simply add the prefix sandbox to all URLs. For example, instead of using the URL https://api.ornament.health/accounting-api/public/v1.0/user/linked-profiles/{pid_or_email}, use the URL https://sandbox-api.ornament.health/accounting-api/public/v1.0/user/linked-profiles/{pid_or_email}
Digitization Flow in Sandbox Environment
The following steps outline how to reproduce the digitization process in the Sandbox environment.
⚠️ Make sure to use Sandbox API URLs for all requests.
- Create a healer account in the Sandbox version of Ornament Pro
- Create a patient using the obtained API key (API reference)
- Create a fileset linked to the newly created patient’s ID (API reference)
- Upload files (using the provided sample links) into the fileset (API reference)
- Send the fileset for digitization (API reference)
- Get digitization completion event via Webhooks (API reference)
- Retrieve the digitized results (biomarkers) from the patient’s profile (API reference)