登录接口
POST /login
登录到服务,并返回服务程序的版本号,以及供后续调用使用的访问令牌。
为了与websocket关联,且会话过期后仍能联动,登录时可以提供一个与websocket一致的共用的令牌(见请求实体属性中的token
属性)。
请求
POST http://localhost:8080/v1/login
Content-Type: application/json
{
"appId": "app1",
"userName":"admin",
"password": "admin"
}
请求实体属性
属性 | 数据类型 | 必要 | 说明 |
---|---|---|---|
appId | string | 应用ID | |
userName | string | Y | 所要验证的用户名。 |
password | string | Y | 所要验证的用户的密码。 |
token | string | 令牌。调用者可以指定令牌。用于在会话超时后重新登录并使用原来获得的令牌。 |
应答
{
"data": [
{
"authToken": "HrWwReOAQ9WdLnJQ1JYivA",
"ver": "1.1.4"
}
],
"count": 1,
"errCode": 0,
"message": "OK."
}
应答实体属性
属性 | 数据类型 | 必要 | 说明 |
---|---|---|---|
errCode | int | Y | 错误码 |
message | string | Y | 错误信息 |
data | array[LoginResult] | 返回的结果对象数组。元素为LoginResult类型,见下 | |
count | int | 返回的记录数 |
LoginResult
属性 | 数据类型 | 必要 | 说明 |
---|---|---|---|
authToken | string | Y | 鉴权令牌,用于后续调用其他接口 |
ver | string | Y | 服务版本字符串。(since 1.1.4) |