Token 鉴权
1. Token 鉴权概述
产品提供的各类API均需鉴权,鉴权通过后方可正常调用。当前产品版本主要提供以下两类鉴权模式:
-
应用级别鉴权 - 应用Token
-
个人级别鉴权 - 个人Token(X-Auth-Token)
2. 应用Token
(1)以管理员身份登录,点击右上角九宫格中的“管理员设置”,进入“系统集成-统一账户集成”页面。
(2)获取账号同步令牌(Token)。账号同步令牌(Token)是调用相关Public API时的唯一身份凭证。需妥善保管该令牌,如果发现疑似泄露,请及时更新重置。 同时建议绑定IP白名单。
3. 个人Token
3.1 接口简介
通过个人账号与密码模拟登录获取合法Token。
请求方式:POST
请求地址:public-api/sign-in
3.2 参数说明
参数名 | 参数值说明 | Location | 类型 | 是否必填 | 备注 |
Content-Type | 内容类型 | Header | String | 是 | -- |
domain | 域名 | Body | String | 是 | 在观远系统中的域名,非网址的域名 |
loginId | 用户界面登录以及通过api管理用户属性的id | Body | String | 是 | -- |
password | 密码 | Body | String | 是 | 原始密码经过Base64编码后的字符串 |
3.3 请求与响应示例
Header Sample:
{
"Content-Type": "application/json; charset=utf-8"
}
POST Body Sample:
{
"domain":"demo",
"loginId": "Id1"
"password":"my_password_base64_encoded"
}
注意:参数中的password需要base64 encode。
Response Sample:
{
"result":"ok",
"response":
{
"token":"guanyuan token", /* 该token在后面调用其他接口时使用 */
"expireAt":"2018-02-06 00:11:12.13"
}
}