瀏覽全部文件

版本管理與棄用

瞭解我們如何管理 API 版本、發布變更,以及在不相容變更或移除前發出通知。

API 與 SDK 版本

REST API 版本位於路徑中:/v1。沒有版本標頭。位於 /mcp 的 MCP 會協商自身的通訊協定版本。

SDK 套件版本與 API 版本相互獨立。

相容變更

在 /v1 中,我們可以新增端點、MCP 工具、資料集、國家或涵蓋範圍,以及維持現有行為的選用輸入。這些變更可隨時發布,恕不另行通知。

我們也可以不經事先通知,新增選用或可為 null 的回應欄位,以及回應列舉中的新值。我們會將這些變更列入更新日誌。

用戶端應忽略未知欄位,並接受未知的列舉值。我們的 SDK 已採用這種處理方式。

不相容變更

移除欄位或變更欄位名稱屬於不相容變更。變更欄位的型別、含義、單位、精確度或是否必填也屬於不相容變更。

變更路由或方法、驗證、授權、配額或預設行為也屬於不相容變更。

我們會透過新路徑、新操作或新的主要版本發布不相容變更。我們不會悄然變更現有路徑、操作或版本。

變更前通知

如果不相容變更或移除影響到您的帳戶在過去 90 天內呼叫過的端點或欄位,我們會至少提前 3 個月通知您。我們會透過電子郵件和更新日誌通知您。

對於過去 90 天內沒有任何帳戶呼叫過的端點或欄位,我們可能在較短的通知期後移除。我們會在更新日誌中公告這些移除事項。

變更公告管道

我們會在更新日誌及其 RSS 訂閱來源中公告變更。

變更日誌 · 更新日誌 RSS 訂閱來源

目前已棄用

經濟事件中的 event_type 欄位是 type 的已棄用別名。請使用 type。

目前尚未設定移除日期。設定日期時,我們會遵循上述通知政策。