除少數接口外，對REST API 發起的任何請求都必須通過身份驗證，未驗證的請求將返回 401 Unauthorized 錯誤。

所有的REST API調用均通過專門的API密鑰完成，該密鑰是一串字符串，SiteServer CMS 后臺能夠對密鑰進行管理，設置此密鑰的訪問權限、替換或讓此密鑰失效。

使用最高權限的管理員登錄 SiteServer CMS 管理后臺，進入菜單系統管理 -> 實用工具 -> API密鑰：

在此可以新增密鑰，設置授權范圍以及刪除密鑰。新增密鑰并設置好授權范圍后點擊API密鑰名稱，進入密鑰查看界面：

建議定期更換API密鑰以確保安全，可以點擊重設 Token按鈕更換API密鑰。

獲取API密鑰之后需要在調用REST API時將密鑰通過請求發送給服務器，目前系統支持兩種方式發送API密鑰：

• 通過Header發送API密鑰

• 通過傳參發送API密鑰

如果身份認證成功，返回HTTP 200，如果身份驗證失敗，返回HTTP 401。

使用Header方法送API密鑰需要在發起請求時將密鑰放到 X-SS-API-KEY Header中：

請求

GET //example.com/api/v1/sitesCopy to clipboardErrorCopied

請求 Header

X-SS-API-KEY: 5c32ea3a-adbb-4434-aa3f-dc49a40d07e8Copy to clipboardErrorCopied

響應

200Copy to clipboardErrorCopied

使用傳參方法送API密鑰需要在發起請求時將密鑰放到 apiKey 的請求參數中：

請求

GET //example.com/api/v1/sites?apiKey=5c32ea3a-adbb-4434-aa3f-dc49a40d07e8Copy to clipboardErrorCopied

響應

200Copy to clipboardErrorCopied