单点登录
# 单点登录
# 接口声明
在调用接口时必须在 https 请求的 header 中携带 "token" 参数。
Token 是智齿客服接口开放平台全局唯一的接口调用凭据。 开发者在调用各业务接口时都需使用 Token,开发者需要进行妥善保存。 Token 的存储至少要保留 32 个字符空间。Token 的有效期目前为 24 个小时,需定时刷新,或根据接口返回的 Token 失效提示,进行重新获取。请求 Token 接口,无论 Token 是否存在,都会返回新的 Token,并重置 Token 的过期时间(目前 24 小时)。
Token 使用方式说明:
1、开发者需要统一获取和管理 Token,在调用智齿客服各个业务开放接口时都应该使用同一个的 Token,不应该每个业务都刷新获取新的 Token,否则容易导致 Token 失效,影响接口的正常调用;
2、目前 Token 的有效期通过返回的 expire_in 来传达,目前是 86,400 秒之内的值。开发者需要根据这个有效时间提前去刷新新 Token。
3、开发者需要根据接口返回的 Token 失效提示,进行重新获取 Token。
# 接口调用
# ● 获取访问 Token 编码
接口说明:
获取 API 开放接口 Token,此 Token 仅适用于智齿开放平台 5.0 版本全部 API 接口 。API接口中的参数 appid、app_key 请联系智齿售后人员获取。
请求方式:
GET
请求地址:
https://www.sobot.com/api/get_token
请求参数:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
appid | String | 是 | 第三方用户接口调用唯一凭证id |
create_time | String | 是 | 时间戳(秒),例如:2019-09-25 15:49:33 的时间戳1569397773 |
sign | String | 是 | 签名,md5(appid+create_time+app_key) sign签名,app_key为密钥 |
返回参数:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
ret_code | String | 是 | 返回编码 |
ret_msg | String | 是 | 返回信息 |
item | Object | 否 | 返回对象 |
item 对象:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
token | String | 是 | token 编码 |
expires_in | String | 是 | 凭证有效时间 |
时间戳转换参考工具:
http://tool.chinaz.com/Tools/unixtime.aspx
sign 签名生成示例:
例如,appid = "1"; create_time="1569397773"; app_key="2"
sign = Md5("115693977732") 为 258eec3118705112b2c53dc8043d4d34。
请求示例:
curl https://www.sobot.com/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34
返回示例:
{
"item": {
"token": "4ac37cb2e9c740dba4b75a34d5358802",
"expires_in": "86400"
},
"ret_code": "000000",
"ret_msg": "操作成功"
}
2
3
4
5
6
7
8
# ● 单点登录
接口说明:
接口类型:主动调用接口。
接口作用:可通过调用该接口来获取一个临时的 URL,通过访问该 URL 即可直接进入某账号的智齿客服后台,从而实现单点登录的业务。
请求方式:POST
请求地址:
https(http)://www.sobot.com/api/public/sso/5/login_url
注:使用 https 请求返回的登录链接是 https 协议的,使用 http 请求,返回的登录链接就是 http 协议的
请求参数:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
agent_email | String | 是 | 客服邮箱 |
type | String | 否 | 登录页面,2:在线工作台,3:呼叫工作台,4:新版智齿管理后台,5:客服工作台 不传,返回的页面链接是智齿管理后台页面 |
status | Integer | 否 | 登录状态, 1:在线,2:忙碌 |
redirect_url | String | 否 | 想要访问的页面的路径,可登录系统后台在浏览器的地址中获取;不传,返回的页面链接是智齿管理后台页面;当与type同时存在时,优先取type的参数 传入的URL路径要求 1、仅支持新版console的URL; 2、仅支持工单中心、在线客服产品线的URL; 3、仅支持管理工作台,不支持在线工作台、呼叫工作台的URL; |
enable_menu | String | 否 | 是否保留智齿左侧产品栏目 1-是,2-否,默认1 |
logout_url | String | 否 | 当用户注销后,界面跳转至该URL页面上,不传,则跳转到智齿登录页面 |
返回参数:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
ret_code | String | 是 | 返回编码 |
ret_msg | String | 是 | 返回信息 |
item | Object | 是 | 返回对象 |
item对象:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
url | String | 是 | 跳转地址 |
请求示例:
curl https(http)://www.sobot.com/api/public/sso/5/login_url
-X POST
-H 'content-type: application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802'
-d '
{
"agent_email": "xiaoming@sobot.com",
"type": "1",
"status": 1
}'
2
3
4
5
6
7
8
9
10
返回示例:
{
"item": {
"url": "https://www.sobot.com/console/openAPI/login/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxODUwMDM5NTY2OEAxNjMuY29tIiwiZXhwIjoxNTczMjcxMTc2fQ.__nZg_aekTGUwz7qoz_Cw7bIF9sQ66ughijr1FLsX9c"
},
"ret_code": "000000",
"ret_msg": "操作成功"
}
2
3
4
5
6
7