Platform & Developer Experience
A scoped REST API, OAuth, signed webhooks, an MCP server and a developer portal for building on your store data.
The platform exposes your catalog, orders, inventory and customers to your own code. Developers get scoped API keys or OAuth tokens, a REST API with consistent error responses, signed webhooks with a delivery log, and an MCP server for AI tools, all managed from a developer portal in the admin. Behind the scenes, feature flags, tenant snapshots and per-tenant backup encryption support safer releases and recovery.
What Platform & Developer Experience does
10 capabilities, each described as it works today.
REST API with scoped access
A versioned REST API for products, orders, inventory, customers, feeds and webhooks, limited by scopes you grant.
The public API lives under /api/v1 and covers products, orders, inventory, customers, feeds, webhooks and the calling key's own details. Every request is limited by scopes such as products:read, orders:write or inventory:write, so a key can do only what you gave it. Errors come back in a standard problem-details format, and responses include rate-limit headers. The rate limiter keeps its counts in memory on each server instance, so treat the headers as guidance rather than an exact quota.
- Resources: products, orders, inventory, customers, feeds and webhooks
- Twelve scopes, read and write, enforced on every call
- Standard problem-details error responses
- Rate-limit headers on responses
- The rate limiter counts per server instance, so limits are approximate
OAuth and API keys
Issue API keys or let apps connect with OAuth 2.0, and revoke or rotate them from the portal.
Apps can connect with OAuth 2.0 using the authorisation-code flow with PKCE, refresh tokens or client credentials. Access tokens last one hour and refresh tokens last 30 days. API keys are issued from the developer portal and can be rotated there.
- Authorisation code with PKCE, refresh tokens and client credentials
- One-hour access tokens and 30-day refresh tokens
- API keys that can be rotated from the portal
Developer portal
Manage keys, OAuth apps, webhooks and usage, and read the docs, from the admin.
The developer portal in the admin has pages for API keys, OAuth apps, webhooks, usage and documentation. The usage page shows API request volume and error rates. There is no interactive request builder yet.
- Keys, OAuth apps, webhooks, usage and docs in one place
- API request volume and error rates on the usage page
- No interactive request builder yet
OpenAPI document
A maintained OpenAPI 3.1 description of the public API.
An OpenAPI 3.1 document is served at /api/openapi.json. It is maintained by hand, covers the public API as a whole rather than per business, and is cached for an hour. It is not generated from the code on each release, so check it against the API when you depend on a detail.
- OpenAPI 3.1 at /api/openapi.json
- Maintained by hand, one document for the whole API
- Cached for an hour
MCP server for AI tools
NewLet an AI tool search your catalog, read products and create orders through a scoped MCP connection.
A tenant-scoped MCP server speaks JSON-RPC and exposes six tools: search products, get a product, get recommendations, list categories, create an order and update inventory. The caller needs the mcp:invoke scope plus the scope for any write. It does not expose customers or segments.
- Six tools: search products, get product, recommendations, categories, create order and update inventory
- Scoped by the key or token that connects
- Customers and segments are not exposed
TypeScript client
A small TypeScript client for the REST API.
The @quantum/sdk package is a dependency-free TypeScript client written by hand for the REST API. It is at an early version, and there are no official Python, Go or Ruby clients. Use the REST API and the OpenAPI document for other languages.
- Dependency-free TypeScript client
- Early version (0.1.0), written by hand
- No official Python, Go or Ruby clients
Signed webhooks
Subscribe to events and receive HMAC-signed deliveries, with a log of every attempt.
Webhook deliveries are signed with HMAC-SHA256 so your server can verify them. Each attempt is logged with its status and response. A delivery is tried three times with a growing delay, and one that still fails goes to a dead-letter list that is retried after ten minutes. You can send a test event from the admin. There is no one-click replay of old events and no secret-rotation overlap yet.
- HMAC-SHA256 signatures
- A log of every delivery attempt
- Three attempts, then a dead-letter list retried after ten minutes
- Test events from the admin
- No replay of past events and no secret rotation overlap yet
Feature flags
Turn features on for a percentage of visitors, or switch them off with a kill switch.
Flags can be set for one business or for everyone, with a deterministic percentage rollout so a visitor stays in the same group, and a kill switch. Changes are written to an audit table. Flags are cached for about a minute, so a kill switch can take that long to reach every server.
- Per-business and global flags
- Deterministic percentage rollout
- Kill switch
- Audit table of changes
- Cached for about a minute, so changes are not instant
Tenant snapshots
Take point-in-time snapshots of a business's database and restore from them.
Snapshots of a business's database are taken using Neon branches, which are copy-on-write, and recorded in a snapshot registry that the admin shows. You can restore from a snapshot. This is a snapshot and restore tool, not a writable sandbox that is anonymised and exposed on its own address.
- Point-in-time snapshots using Neon branches
- Snapshot registry in the admin
- Restore from a snapshot
- Not a writable, anonymised sandbox
Encrypted tenant backups
Each business's backup is encrypted with its own key.
Backups are encrypted per business, so removing that business's key makes its backup unreadable. Audit logs follow a PII-redaction policy, and data-subject request types are defined for handling access and erasure requests. This is a set of controls to discuss with your security reviewer, not a certification.
- A separate encryption key for each business's backups
- Deleting the key makes the backup unreadable
- PII redaction policy for audit logs
- Data-subject request types defined
QuantumOS X3 holds no SOC 2 report or ISO certificate, and we do not claim one. For a security review we can walk through the controls, answer a written questionnaire and provide a data processing agreement. See the security page for what exists today.
QuantumOS Dispatch
Insights for commerce operators
Operator stories, platform deep dives and notes on what ships.
We'll send the QuantumOS Dispatch by email. Unsubscribe any time. See our privacy notice.