Partner APIGuide
Partner API overview
One versioned API for programs and catalog, serviceability, orders, results and events.
On this page
What the API covers
- Credential and environment verification.
- Laboratory capability profile and externally serviceable collection locations.
- Programs, program catalog and order requirements.
- Serviceability checks before an order is created.
- Order creation, retrieval and cancellation while cancellation is still possible.
- Released results, result versions and the governed report.
- Canonical exceptions and an event stream for reconciliation.
The exact request and response shapes are published as a machine-readable OpenAPI 3.1 description at /api/public/partner-openapi.
Integration path
- The laboratory registers your client and grants Program access through a canonical Diagnostic Program.
- An authorized Health Company member issues a Sandbox key in the workspace once an active Sandbox Program grant exists; Production keys remain governed by laboratory/Solia issuance.
- Verify the key against the health endpoint.
- Read programs and catalog, then check serviceability.
- Create orders with an idempotency key.
- Read results, and register a webhook endpoint for push delivery.