API reference
Release phases
What beta, stable and deprecated mean for an operation, and what available, partial, hosted only and planned mean for a product.
Release phases tell you how much an operation's shape can still change, and how complete a product is through the APIs.
Operations
Every operation in the API reference carries one phase, also published as x-kanorio-stability in the OpenAPI documents.
| Phase | Meaning | Breaking changes |
|---|---|---|
| Beta | Ready to build on. The shape can still change. | Allowed, announced in the changelog the day they ship |
| Stable | The shape is committed. | Only through deprecation, with at least six months' notice |
| Deprecated | Still works, removed after its sunset date | None. Move to the replacement. |
Products
Each product page shows how much of it the APIs expose today.
| Status | Meaning |
|---|---|
| Available | Read and write through the APIs, with webhooks where events exist |
| Partial | Some of the product is exposed. The product page lists what is not yet |
| Hosted only | Works on sites Kanorio hosts, with no API yet. A headless front end cannot use it |
| Planned | On the roadmap. Not available in any form yet |
| Not offered | Kanorio does not plan to offer it. The product page suggests an alternative |
Planned and not-offered products have no guides or reference pages until they ship.
Status by product
| Product | Status |
|---|---|
| Content & Publishing | Available |
| Customers, Membership & Entitlements | Available |
| Credits, Stored Value & Passes | Planned |
| Catalog | Available |
| Promotions & Pricing Rules | Available |
| Reviews & Ratings | Partial |
| Bookings, Resources & Availability | Planned |
| Transactions & Fulfillment | Available |
| Protected Deliverables & Progress | Available |
| Forms & Data Collection | Available |
| Campaigns & Broadcasts | Available |
| Identity, Tenant & Authorization | Available |
| Media & Assets | Available |
| Events, Workflows & Reliable Execution | Available |
| Messaging & Reach | Available |
| Publishing Delivery, Discovery & Measurement | Partial |
| Locale & Localization | Available |
| Automation | Available |