Skip to main content

API Reference

Integrator-facing HTTP surfaces are documented via published artifacts and SDK Quick Starts.

Runtime API​

Critical paths include activate, validate, lease refresh, device registration, JWKS, plus offline / floating / config delivery as exposed in the OpenAPI document.

Products typically present a human license key through official SDKs when calling Runtime AuthN. Prefer SDK options / env vars over hand-rolled headers; see Runtime Secrets.

Vendor Partner (Management subset)​

Vendors (key sellers) automate Management with a service account Bearer token.

Not published as wholesale dumps: full Management admin OpenAPI, Relay Host OpenAPI, Platform Admin (/api/v1/platform/*), Platform Billing / PBL (/api/v1/billing/*).

Management customer aggregate​

Vendor Console customer profile and masked License composition is documented in the Customer aggregate API. It is a Management contract and is not added to the public Partner subset.

The independently paged enriched License list is documented in the Customer License table API. It composes typed owner-service display results and fails closed instead of returning partial pages.

Customer License actions API documents the dual-permission candidate discovery, durable once-reveal Subscription issue, and atomic customer-scoped revoke/archive routes. These Management routes are not added to the public Partner subset.

Product tariff draft API documents Product-scoped tariff listing and strict, idempotent NewTariff / NextVersion creation. These Management routes are also excluded from the public Partner subset.

Product tariff publish and history API documents immutable version history, optional safe publish actions and strict, idempotent Draft publication. These Management routes are also excluded from the public Partner subset.

Errors and webhooks​

  1. Prefer official SDKs — .NET, JS/TS, Python, Java, Go, Rust, and C++.
  2. Public Runtime error codes: Error catalog (/artifacts/catalogs/errors.v1.json).
  3. Outbound webhook event types: Webhook catalog.

No live credentials or environment samples with secrets belong on this page.