Kanorio

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 offeredKanorio 目前無計畫提供。產品頁面會建議替代方案

已規劃但尚未提供的產品,在正式發佈前不會有指南或參考頁面。

各產品狀態