# 身份验证
# 获取Token
# 接口名称 :
get_token
# 接口说明 :
通过AccessKeyId、AccessKeySecret,获取Token
请求地址:
HTTP:https://openplatform-api.xiaobao100.com/token/get_token (opens new window)
Java:https://openplatform-api.xiaobao100.com (opens new window)
请求方式:
POST
请求类型:
Content-Type: application/json
SDK 请求示例(Java):
TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);
参数:
参数名 | 是否必填 | 参数类型 | 参数描述 |
---|---|---|---|
accessKeyId | 是 | string | AccessKeyId |
accessKeySecret | 是 | string | AccessKeySecret |
# 成功调用时返回:
返回示例:
{
"@string"
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
data | string | token |
# 失败调用时返回:
返回示例:
{
"timestamp": "@integer(60, 100)",
"message": "@string",
"errorCode": 0
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
timestamp | string | 时间戳 |
message | string | 描述信息 |
errorCode | integer | 返回码 |
注意:Java调用失败时会直接报错返回,请做好异常处理
# 获取用户信息
# 接口名称 :
GetCurrentUser
# 接口说明 :
获取免登用的用户详情
请求地址:
HTTP:https://openplatform-api.xiaobao100.com/open-platform/SSO/v2/GetCurrentUser (opens new window)
Java:https://openplatform-api.xiaobao100.com (opens new window)
请求方式:
GET
请求类型:
Content-Type: application/json
请求头:
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数:
参数名 | 是否必填 | 参数类型 | 参数描述 |
---|---|---|---|
code | 否 | string | Code |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
data | object | 返回数据信息 |
id | integer | └ 用户Id |
accountorType | integer | └ 账号类型,1表示员工,2表示学生 |
userHeadImg | string | └ 用户头像 |
cName | string | └ 中文名称 |
eName | string | └ 英文名称 |
msgCN | string | 中文异常信息 |
msgEN | string | 英文异常信息 |
state | integer | 返回码 |
msg | string | 描述信息 |
请求示例(Java SDK):
TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);
SSOApi api = new SSOApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getCurrentUser(parameter [, parameter1, parameter2...])
返回示例:
{
"data": {
"id": "@integer(60, 100)",
"accountorType": 1,
"userHeadImg": "@string",
"cName": "@string",
"eName": "@string"
},
"msgCN": "@string",
"msgEN": "@string",
"state": 0,
"msg": "@string"
}