Solia Direct DocsControl Plane
⌘K

Partner APIGuide

Partner API overview

One versioned API for programs and catalog, serviceability, orders, results and events.

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

  1. The laboratory registers your client and grants program access.
  2. The laboratory issues an API key bound to one environment and one scope set.
  3. Verify the key against the health endpoint.
  4. Read programs and catalog, then check serviceability.
  5. Create orders with an idempotency key.
  6. Read results, and register a webhook endpoint for push delivery.