Skip to content

External Integrators (v1: scaffold only)

Full integrator documentation will be added as integration partners come online.

Currently available

  • Getting started — see docs/integration/README.md for OAuth2 setup, the endpoint catalogue, and the Postman download flow.
  • Routing convention — the platform serves every service on a single host using per-service path prefixes (e.g. /v1/clinical-api/cases, /v1/orchestrator/workflow-instances/:id, /v1/auth/oauth/token). The Integration tab in the admin UI and the downloadable Postman collection both use this convention; old paths like /v1/cases will not resolve after 2026-05-27.
  • Postman collection — downloadable per (org, product) from the admin UI's Integration tab. Scoped to the granted scopes, ships with an empty clientSecret for safety, and includes the OAuth2 token request as folder 0.
  • OpenAPI specs — auto-generated from each service's controllers and emitted as CI artifacts at docs/audiences/integrators/generated/openapi/<service>.json. Generated artifacts are not committed to git; download them from the documentation generation workflow's artifact tab.

Planned (post-v1)

  • Authentication walkthrough (OAuth2 client credentials)
  • SDK reference (Node + Python)
  • Webhook reference