认证API

1、登陆（login）

请求说明

Https请求方式: POST

https://bee.quanshi.com/ucopenapi/auth/token/create

接口功能： 登录UCOPENAPI服务器； 获得Token，API的每次调用都需要Token。

请求参数

{
   "username":"administrator@quanshi.com",
   "password":"111111",
   "role":0,
   "appId":123
}
参数名称 类型 可选 说明
role int 选填 登录角色, 0: 超级管理员(缺省)Username:必填；2: 应用管理员；Username: 必填appId:必填；3: 第三方应用，此时忽略username字段，appId必填
username String 选填 登录帐户名
password String 必填 登录帐户密码
appId int 选填 应用ID，当role为2时， 指定登录的应用

返回结果

{
   "errorCode":0,
   "data":{
      "token":"297ba84a-ed1d-4c35-a04f-ca40d6f0946e",
      "username":" administrator@quanshi.com",
      "role":0,
      "appId":123
   },
   "errorMessage":"Successful!",
   "requestId":"e4e35ede-1d90-42f6-9a51-073789c6ac92"
}
参数名称 类型 可选 说明
errorCode int 必填 0表示成功
data 数据结构 必填 登录帐户名
errorMessage String 必填 执行结果，同errorCode匹配
requestId String 必填 本次请求的唯一编号用
data.token String 必填 登陆成功返回的token信息，API的每次调用都需要
data.username String 必填 登陆账户名

2、检查（check）

请求说明

Https请求方式: POST

https://bee.quanshi.com/ucopenapi/auth/token/check

接口功能： 检测Token是否还有效。同时可刷新登录TOKEN，防止TOKEN超时。

请求参数

{
   "username":"administrator@quanshi.com",
   "token":"297ba84a-ed1d-4c35-a04f-ca40d6f0946e"
}
参数名称 类型 可选 说明
username String 选填 第三方应用登录，此字段不填，下面各个API接口同此定义。
token String 必填 登陆成功的凭证

返回结果

{
   "errorCode" : 0,
   "data" : {
      "token" : "297ba84a-ed1d-4c35-a04f-ca40d6f0946e",
      "username" : "administrator@quanshi.com"
   },
   "errorMessage" : "Successful!",
   "requestId" : "e4e35ede-1d90-42f6-9a51-073789c6ac92"
}
参数名称 类型 可选 说明
errorCode int 必填 0表示成功
data 数据结构 必填 登录帐户名
errorMessage String 必填 执行结果，同errorCode匹配
requestId String 必填 本次请求的唯一编号用
data.token String 必填 登陆成功返回的token信息，API的每次调用都需要
data.username String 必填 登陆账户名

3、退出

请求说明

Https请求方式: POST

https://bee.quanshi.com/ucopenapi/auth/token/delete

接口功能：退出API服务器登录。

请求参数

{
   "username":"administrator@quanshi.com",
   "token":"297ba84a-ed1d-4c35-a04f-ca40d6f0946e"
}
参数名称 类型 可选 说明
username String 选填 第三方应用登录，此字段不填，下面各个API接口同此定义。
token String 必填 登陆成功的凭证

返回结果

{
   "errorCode" : 0,
   "errorMessage" : "Successful!",
   "requestId" : "e4e35ede-1d90-42f6-9a51-073789c6ac92"
}
参数名称 类型 可选 说明
errorCode int 必填 0表示成功
errorMessage String 必填 执行结果，同errorCode匹配
requestId String 必填 本次请求的唯一编号用