ESET 雲端控制台應用程式介面(API)
要了解變更如何影響整合,區分閘 道 器與其服務的 應用程式介面(API)類別 非常重要。
ESET Connect(閘道器)
ESET Connect 是一個由 ESET 完全管理的雲端閘道。它作為以下 ESET 雲端服務客戶端與後端服務之間的入口:
ESET Connect API 類別
閘道器提供特定 API 集合的存取,這些 API 依類別組織。
版本控制 |
每個 API 類別都有其獨立的版本週期。這就是你在程式碼連結中指定的版本(例如 /v1/groups)。 |
撞擊式 |
ESET Connect API 類別的更新可能會改變 API 呼叫。 |
終止支援原則 |
變動政策
如果變更被視為非破壞性,ESET可在事先通知下進行變更。
ESET會合理 地提前通知您有變動 ,並有足夠時間讓您適應這些變更。 |
破壞性變更 是指應用程式介面(API)的變更,可能需要對應用程式進行修改以避免整合中斷,或為了維持相容性而必須做出修改。
以下是我們認為屬於破壞性變更的幾個範例:
•回應格式變更,
•田地更名,
•欄位已移除,
•資料型別變更,
•錯誤代碼變更,
•業務邏輯的改變。
破壞性變更也可能由與驗證、權限範圍、速率限制、傳輸/URL 變更及其他因素相關的變更所引起。
不破壞性的改變 是指你可以依照自己的判斷和節奏調整,且不會被打斷。
以下是一些我們認為 不 屬於破壞性變更的變更範例:
•新欄位補充,
•新增可選參數,
•新增價值,
•提高速率限制,
•支援更多格式等。
過渡時期
在過渡期間,隨著新 API 類別版本或功能替換推出後,先前版本仍可使用的時間段內,先前版本將持續提供一段限定的有限支援期間。ESET將盡 合理努力 確保相容性,並給予客戶足夠時間適應這些變化。
ESET Connect API 類別版本的 有限支援 會從公告日期開始,通常是在向終端客戶公開公告的日期。ESET Connect API 類別版本將移至有限支援,並持續提供至終止服務日期。在有限支援結束後,ESET Connect API 類別版本將不再提供。
版本控制規則
變革之末 |
任何包含破壞性變更的版本都會在文件中明確標示。 |
非破壞性變更 |
若發布僅包含非破壞性變更,API 類別版本保持不變。詳細資訊請參閱 ESET Connect 的說明文件。 |