身份認(rèn)證

除少數(shù)接口外，對(duì)REST API 發(fā)起的任何請(qǐng)求都必須通過(guò)身份驗(yàn)證，未驗(yàn)證的請(qǐng)求將返回 401 Unauthorized 錯(cuò)誤。

獲取API密鑰

所有的REST API調(diào)用均通過(guò)專門(mén)的API密鑰完成，該密鑰是一串字符串，SiteServer CMS 后臺(tái)能夠?qū)γ荑€進(jìn)行管理，設(shè)置此密鑰的訪問(wèn)權(quán)限、替換或讓此密鑰失效。

使用最高權(quán)限的管理員登錄 SiteServer CMS 管理后臺(tái)，進(jìn)入菜單系統(tǒng)管理 -> 實(shí)用工具 -> API密鑰：

在此可以新增密鑰，設(shè)置授權(quán)范圍以及刪除密鑰。新增密鑰并設(shè)置好授權(quán)范圍后點(diǎn)擊API密鑰名稱，進(jìn)入密鑰查看界面：

建議定期更換API密鑰以確保安全，可以點(diǎn)擊重設(shè) Token按鈕更換API密鑰。

使用API密鑰進(jìn)行身份認(rèn)證

獲取API密鑰之后需要在調(diào)用REST API時(shí)將密鑰通過(guò)請(qǐng)求發(fā)送給服務(wù)器，目前系統(tǒng)支持兩種方式發(fā)送API密鑰：

• 通過(guò)Header發(fā)送API密鑰

• 通過(guò)傳參發(fā)送API密鑰

如果身份認(rèn)證成功，返回HTTP 200，如果身份驗(yàn)證失敗，返回HTTP 401。

通過(guò)Header發(fā)送API密鑰

使用Header方法送API密鑰需要在發(fā)起請(qǐng)求時(shí)將密鑰放到 X-SS-API-KEY Header中：

請(qǐng)求

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

請(qǐng)求 Header

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

響應(yīng)

200Copy to clipboardErrorCopied

通過(guò)傳參發(fā)送API密鑰

使用傳參方法送API密鑰需要在發(fā)起請(qǐng)求時(shí)將密鑰放到 apiKey 的請(qǐng)求參數(shù)中：

請(qǐng)求

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

響應(yīng)

200Copy to clipboardErrorCopied

無(wú)需認(rèn)證的API接口

操作	請(qǐng)求	地址	說(shuō)明
獲取用戶頭像	GET	v1/users/{id}/avatar	獲取用戶頭像地址
用戶登錄	POST	v1/users/actions/login	用戶登錄操作

本頁(yè)內(nèi)容由塔燈網(wǎng)絡(luò)科技有限公司通過(guò)網(wǎng)絡(luò)收集編輯所得，所有資料僅供用戶參考了本站不擁有所有權(quán)，如您認(rèn)為本網(wǎng)頁(yè)中由涉嫌抄襲的內(nèi)容，請(qǐng)及時(shí)與我們聯(lián)系，并提供相關(guān)證據(jù)，工作人員會(huì)在5工作日內(nèi)聯(lián)系您，一經(jīng)查實(shí)，本站立刻刪除侵權(quán)內(nèi)容。本文鏈接:http://m.jstctz.cn/18185.html