Documentation
Operator and builder guides for Quanon Platform. These pages describe how the planes fit together — not mock deep links into unfinished workspaces.
Platform architecture
Quanon is a shared control plane for identity, licensing, billing, marketplace, and gateway services. Product runtimes stay independently deployable and never mix tenant business data into the platform database.
- Corporate systems, Quanon Platform, and SaaS products remain separate planes
- Commercial access is expressed as entitlements, not hard-coded feature flags in products
- API credentials authenticate at the gateway before product or CanonAI routes
Multi-tenant routing
Customer product apps resolve under a tenant slug. Platform routes such as /admin, /portal, /login, /setup, and /docs are reserved and never collide with tenant namespaces.
- Canonical tenant paths look like /{tenant}/dashboard
- Platform operators use /admin; organization users use /portal with org-scoped data
- First production boot uses /setup to create the Quanon Systems platform owner and register a passkey
- Tenant provision mutations require a platform-admin MFA session
Customer portal
The portal is the self-service surface for organizations: products, entitlements, licenses, billing, API credentials, downloads, marketplace, and support.
- Distinct from the operator control plane at /admin
- Distinct from tenant business apps under slug routes
- Sign in to manage licenses, invoices, and team access
Developer platform
SDKs, APIs, webhooks, and plugins extend Quanon without bypassing commercial or identity checks. Credential scopes and entitlement keys remain authoritative.
- Prefer scoped API keys over long-lived shared secrets
- Rotate credentials from the portal or control plane
- Validate feature access through entitlements on every paid capability
SDK downloads
Java SDK is publish-ready (GitHub Packages / Maven Central profile). TypeScript SDK verifies Ed25519 tokens via Web Crypto — publish with NPM_TOKEN.
Java license SDK
v0.0.1-SNAPSHOT · JVM 21+
licensing/quanon-license-sdk-java — Ed25519 verify + heartbeat. Publish-ready (sources/javadoc + GitHub Packages).
TypeScript license SDK
v0.0.1 · Node 20+
licensing/quanon-license-sdk-ts — Ed25519 WebCrypto verify. Publish via npm / publish-sdks workflow.
OpenAPI specifications
Checked-in contracts under /openapi/*. While the backend is running, also use springdoc at http://localhost:4040/v3/api-docs.
| Service | Spec path | Operations |
|---|---|---|
| Identity Platform | /openapi/identity/v1.yaml | 7 |
| Licensing | /openapi/licensing/v1.yaml | 4 |
| API Gateway | /openapi/gateway/v1.yaml | 4 |
| Customer Portal | /openapi/portal/v1.yaml | 4 |
| Provisioning | /openapi/provisioning/v1.yaml | 2 |
| Developer Platform | /openapi/developer/v1.yaml | 3 |