Integration GuidesGuide
Existing operations systems (headless)
Running Solia behind your own internal operations, practitioner or business system through the Partner API and webhooks.
When to use it
Use this model when your own internal operations, practitioner or custom business system places orders and consumes results. The system integrates through the Partner API and signed webhooks; Solia remains the laboratory-operations backend.
The same Partner API contract serves internal systems and external partners. "Partner API" is the contract name; any API integration — internal system or external partner — uses the same scopes, Program grants, orders, results and events.
Important
This is distinct from Existing Laboratory Portal, which is a Standard DTC patient-results routing mode to the laboratory's own HTTPS portal.
Responsibilities
- Your system: user experience, order capture and result presentation for its own users.
- Partner API + webhooks: the only integration path for orders, results and events.
- Control Plane: administration, configuration and governance — integrations, keys, Programs, Catalog, laboratory connection and activation.
- There is no second order or result model; every API order and result is the canonical Solia record.
Integration test
In the Control Plane, Integrations → Integration test → Run integration test checks a Sandbox integration end to end. Steps report in order:
- API authenticated
- Program accessible
- Catalog retrieved
- Test order accepted
- Laboratory transmission complete
- Result received
- Result released
- Webhook delivered
Limitation
A failed step stops the run and reports where it stopped; it does not activate Production.
- Partner API conformance — the Integration test above: your Sandbox integration can authenticate, order and receive released results and events.
- Laboratory connection validation — the laboratory's own connection test of its endpoint and signed inbound events; separate from your integration.
- Production readiness — a separate activation with its own credentials, Program access and checks. Passing Sandbox never authorizes Production.
Developer path
- Create a Sandbox API integration and key.
- Confirm Program access for the key.
- Read the Catalog.
- Check serviceability.
- Submit an order with an idempotency key.
- Laboratory transport delivers the order.
- Receive the released result.
- Receive the signed webhook event.
- Reconcile with the events endpoint.
Exact endpoints, schemas and scopes are in the generated API Reference. There is no Solia SDK.