API 参考
发布阶段
说明操作的 Beta、Stable 与 Deprecated 的含义,以及产品的 Available、Partial、Hosted only 与 Planned 的含义。
发布阶段说明了操作的结构变更程度,以及通过 API 提供的产品完整度。
操作
API 参考文档中的每个操作都带有一个阶段,该阶段也会在 OpenAPI 文档中以 x-kanorio-stability 发布。
| 阶段 | 含义 | 重大变更 |
|---|---|---|
| Beta | 适合开始建站。架构仍可能调整。 | 允许,将在发布当日于更新日志中公告 |
| Stable | 架构已定案。 | 仅能通过弃用流程,并至少提前六个月通知 |
| Deprecated | 仍可运作,将在停用日期后移除。 | 无。请改用替代方案。 |
产品
每个产品页面都会显示目前 API 所公开的程度。
| 状态 | 含义 |
|---|---|
| Available | 可透过 API 读写,并在有事件时提供 Webhooks |
| Partial | 部分产品功能已开放。产品页面会列出尚未开放的部分 |
| Hosted only | 仅适用于 Kanorio 托管的网站,暂无 API。Headless 前端无法使用 |
| Planned | 已列入开发蓝图。目前尚未以任何形式提供 |
| Not offered | Kanorio 目前无计划提供。产品页面会建议替代方案 |
已规划但尚未提供的产品,在正式发布前不会有指南或参考页面。
各产品状态
| 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 |