15.鉴权中台API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
15.1 | 获取AccessToken | /v1/cas/extension/auth/get/token | 1.0 |
15.2 | 校验AccessToken | /v1/cas/extension/auth/validate/token | 1.0 |
15.3 | 刷新AccessToken | /v1/cas/extension/auth/refresh/token | 1.0 |
15.4 | 校验睿住云管家token | /mid/user/authenticate/token |
云云对接鉴权
Header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
timestamp | Header | STRING | 是 | 时间戳,格式:yyyyMMddHHmmss |
encode | Header | STRING | 是 | 签名,appcode+appkey+timestamp+{appkey} sha256加密后值 |
appcode | Header | STRING | 是 | 应用码 |
API调用
15.1: 获取AccessToken
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/cas/ext/auth/get/token
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
username | BODY | STRING | 是 | 用户名 |
password | BODY | STRING | 是 | 密码 |
请求Body描述(非Form表单数据)
{
"username": "678345",
"password": "123456"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
access_token | data | STRING | 是 | 鉴权Token |
refresh_token | data | STRING | 是 | 刷新Token |
expire_in | data | INT | 是 | 失效时间(秒) |
返回结果示例
{
"code": 200,
"data": {
"access_token": "MTBENjU2NkVBNDdGMTRGMzUwQUJGMDc0M0UyRDlENkQ1NkVERUQ1NTYyNDQwNEM2QzNDMTIwRkI1NEI3MUY1RQ==",
"refresh_token": "MDhEMEU2NDVCNUJGMUY4NzZFMkI0NERGQkJCQjQxQjQ2RTMzQTlGMTE0OTdGOUEwQjRGM0NGNjA0NTk1NUUwNQ==",
"expire_in": 1800
},
"message": "success"
}
15.2: 校验AccessToken
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/cas/ext/auth/validate/token
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
access_token | BODY | STRING | 是 | 鉴权token |
请求Body描述(非Form表单数据)
{
"access_token": "MTBENjU2NkVBNDdGMTRGMzUwQUJGMDc0M0UyRDlENkQ1NkVERUQ1NTYyNDQwNEM2QzNDMTIwRkI1NEI3MUY1RQ=="
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
phone | data | STRING | 是 | 手机号 |
account | data | STRING | 是 | 账号名 |
返回结果示例
{
"code": 200,
"data": {
"phone": "13809098989",
"account": "678345"
},
"message": "success"
}
15.3: 刷新AccessToken
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/cas/ext/auth/refresh/token
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
refresh_token | BODY | STRING | 是 | 刷新token |
请求Body描述(非Form表单数据)
{
"refresh_token": "MTBENjU2NkVBNDdGMTRGMzUwQUJGMDc0M0UyRDlENkQ1NkVERUQ1NTYyNDQwNEM2QzNDMTIwRkI1NEI3MUY1RQ=="
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
access_token | data | STRING | 是 | 鉴权Token |
refresh_token | data | STRING | 是 | 刷新Token |
expire_in | data | INT | 是 | 失效时间(秒) |
返回结果示例
{
"code": 200,
"data": {
"access_token": "MTBENjU2NkVBNDdGMTRGMzUwQUJGMDc0M0UyRDlENkQ1NkVERUQ1NTYyNDQwNEM2QzNDMTIwRkI1NEI3MUY1RQ==",
"refresh_token": "MDhEMEU2NDVCNUJGMUY4NzZFMkI0NERGQkJCQjQxQjQ2RTMzQTlGMTE0OTdGOUEwQjRGM0NGNjA0NTk1NUUwNQ==",
"expire_in": 1800
},
"message": "success"
}
15.4: 校验睿住云管家token
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/mid/user/authenticate/token
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
Access-Token | Header | STRING | 是 | token |
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
userId | data | STRING | 是 | 用户ID |
返回结果示例
{
"code": 200,
"data": {
"userId": "32"
},
"message": "success"
}
错误码列表(2301-2399)
错误码 | 错误信息 | 描述 |
---|---|---|
11017 | 访问令牌无效 | token失效 |