# 认证 API
# 生成 Token
接口地址:/api/open/v2/token
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"body": {
"appKey": "",
"appSecret": "",
"password": "",
"username": ""
}
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
tokenRequest | tokenRequest | body | true | RequestParameter«TokenRequest» | RequestParameter«TokenRequest» |
body | false | TokenRequest | TokenRequest | ||
appKey | 应用 Key | true | string | ||
appSecret | 应用 Secret | true | string | ||
password | 新核云系统用户密码 | false | string | ||
username | 新核云系统用户名 | false | string |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | EntityResponse«OpenApiTokenDTO» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | EntityResponseData«OpenApiTokenDTO» | EntityResponseData«OpenApiTokenDTO» | |
entity | OpenApiTokenDTO | OpenApiTokenDTO | |
accessToken | 调用凭证 | string | |
accessTokenExpireIn | 凭证超时时间 | integer | |
refreshToken | 刷新token | string | |
refreshTokenExpireIn | 刷新凭证超时时间 | integer | |
message | string |
响应示例:
{
"code": 0,
"data": {
"entity": {
"accessToken": "",
"accessTokenExpireIn": 0,
"refreshToken": "",
"refreshTokenExpireIn": 0
}
},
"message": ""
}
# 刷新 Token
接口地址:/api/open/v2/token
请求方式:PUT
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"body": {
"refreshToken": ""
}
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
tokenRequest | tokenRequest | body | true | RequestParameter«TokenRefresh» | RequestParameter«TokenRefresh» |
body | false | TokenRefresh | TokenRefresh | ||
refreshToken | 刷新 Token | true | string |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | EntityResponse«OpenApiTokenDTO» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | EntityResponseData«OpenApiTokenDTO» | EntityResponseData«OpenApiTokenDTO» | |
entity | OpenApiTokenDTO | OpenApiTokenDTO | |
accessToken | 调用凭证 | string | |
accessTokenExpireIn | 凭证超时时间 | integer | |
refreshToken | 刷新token | string | |
refreshTokenExpireIn | 刷新凭证超时时间 | integer | |
message | string |
响应示例:
{
"code": 0,
"data": {
"entity": {
"accessToken": "",
"accessTokenExpireIn": 0,
"refreshToken": "",
"refreshTokenExpireIn": 0
}
},
"message": ""
}