The API allows you to integrate the platform's testing capabilities directly into your own systems. You can programmatically create orders, manage clients, and retrieve results without using the practitioner portal interface.
Prerequisites
Before you can use the API, you'll need:
A verified practitioner account with an organisation set up
Valid billing details on your organisation (required to enable API access)
Agreement to the API terms of service
Enabling API access
Log in to the practitioner portal and select your organisation.
Go to Settings > API Keys.
Read and agree to the API terms.
Add your billing information if you haven't already.
Click Enable API.
Once enabled, your API key will be generated and displayed. Store this key securely as you'll need it to authenticate your API requests.
Authentication
All API requests require your API key to be included in the request headers. Refer to the API documentation provided when you enable access for the specific header format and authentication details.
Key capabilities
The API supports the core workflows available in the practitioner portal:
Test bundles. Create, list, and manage test bundles programmatically.
Orders. Place orders for clients and track their status.
Results. Retrieve results for your clients as they become available.
Clients. Manage your client list and view their history.
Testing
A staging environment is available for testing your integration before going live. Contact support for staging API access and endpoint details.
Getting help
If you need assistance with your integration or have questions about specific API endpoints, reach out to the support team. We can provide technical documentation and help troubleshoot any issues.