Solia Direct DocsControl Plane
⌘K

Partner APIGuide

API clients

How partner clients are registered and how keys are issued.

The laboratory's Production setup sequence

  1. Create Production integration — Register the Production integration that will access this laboratory.
  2. Grant Production Program access — Choose which active Production Programs this integration can use.
  3. Issue Production API key — Issue its key after Program access and security requirements are satisfied.
  4. Configure webhook — Configure delivery for order updates and released results.

The Control Plane presents exactly this sequence and marks the first unmet step as the current one. This API documentation is a reference resource, not a step in that sequence.

Registration and issuance

The laboratory registers an API client in Integrations → API clients. Registering a client does not issue a key: issuance is a separate, deliberate action.

Issuing a Production key requires an active client, an active program grant to an enabled Production program in the same workspace and environment, and the laboratory's own production security requirements — including a verified multi-factor challenge — to be satisfied.

  • Client registration never auto-issues a Production key.
  • An integration and its grants, keys and webhook subscriptions are environment-specific; a Sandbox integration cannot serve Production.
  • Key values are shown once and cannot be retrieved later.
  • A key can be replaced; the client's identity and grants are unaffected.