API認證

所有 API 請求都必須經過身份驗證。 EC-Permit 支援伺服器到伺服器通訊的 API 金鑰驗證。

API金鑰認證

將您的 API 金鑰包含在

授權

標頭：

請求範例

API 金鑰類型

只讀鍵

只能取得數據。無法建立、更新或刪除資源。

讀寫按鍵

對 GET、POST、PUT、DELETE 操作的完全存取權。

身份驗證錯誤

401 未經授權

API 金鑰缺失或無效

403 禁忌

API 金鑰無權執行此操作

429 請求過多

超出速率限制

安全最佳實踐

確保您的 API 金鑰安全：

切勿在客戶端程式碼中公開密鑰

使用環境變量，而不是硬編碼值

不要將密鑰提交給版本控制

定期輪換密鑰

使用單獨的金鑰進行開發和生產

旋轉鑰匙

要輪換 API 金鑰：

建立新的 API 金鑰

更新您的應用程式以使用新金鑰

驗證新密鑰是否正常運作

刪除舊密鑰

刪除密鑰會立即使其失效。在刪除金鑰之前，請確保沒有活動系統仍在使用該金鑰。

API概述

端點參考