身份认证

除少数接口外，对REST API 发起的任何请求都必须通过身份验证，未验证的请求将返回 401 Unauthorized 错误。

获取API密钥

所有的REST API调用均通过专门的API密钥完成，该密钥是一串字符串，SiteServer CMS 后台能够对密钥进行管理，设置此密钥的访问权限、替换或让此密钥失效。

使用最高权限的管理员登录 SiteServer CMS 管理后台，进入菜单系统管理 -> 实用工具 -> API密钥：

在此可以新增密钥，设置授权范围以及删除密钥。新增密钥并设置好授权范围后点击API密钥名称，进入密钥查看界面：

建议定期更换API密钥以确保安全，可以点击重设 Token按钮更换API密钥。

使用API密钥进行身份认证

获取API密钥之后需要在调用REST API时将密钥通过请求发送给服务器，目前系统支持两种方式发送API密钥：

• 通过Header发送API密钥

• 通过传参发送API密钥

如果身份认证成功，返回HTTP 200，如果身份验证失败，返回HTTP 401。

通过Header发送API密钥

使用Header方法送API密钥需要在发起请求时将密钥放到 X-SS-API-KEY Header中：

请求

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

请求 Header

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

响应

200Copy to clipboardErrorCopied

通过传参发送API密钥

使用传参方法送API密钥需要在发起请求时将密钥放到 apiKey 的请求参数中：

请求

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

响应

200Copy to clipboardErrorCopied

无需认证的API接口

操作	请求	地址	说明
获取用户头像	GET	v1/users/{id}/avatar	获取用户头像地址
用户登录	POST	v1/users/actions/login	用户登录操作

本页内容由塔灯网络科技有限公司通过网络收集编辑所得，所有资料仅供用户参考了本站不拥有所有权，如您认为本网页中由涉嫌抄袭的内容，请及时与我们联系，并提供相关证据，工作人员会在5工作日内联系您，一经查实，本站立刻删除侵权内容。本文链接:https://dengtar.com/18185.html