登录接口
第三方平台对接,首先要实现的API接口就是用户登录接口,通过该接口返回正确的Token值;
登录接口示例
请求接口示例,192.168.1.108是GVP服务端所在电脑的IP地址,请根据实际情况调整
http://192.168.1.108:8008/api/?HDLRequest=UserLogin
请求方式:POST
接口地址:/api/?HDLRequest=UserLogin
请求数据类型:application/json
响应数据类型:application/json
接口描述: 用户登录接口,成功返回用户信息,包含Token值
Headers参数,无
Key | Value | 描述 |
---|---|---|
Authorization | 空 | 用户登录接口,无需Headers参数,可为空 |
请求参数
字段 | 类型 | 是否必须 | 描述 |
---|---|---|---|
UserName | String | true | 登录的用户名 |
UserPassword | String | true | 登录的密码 |
请求示例,但是最后要使用加密方法加密字符串才提交
{
"UserName": "",
"UserPassword": ""
}
响应参数:
字段 | 类型 | 描述 |
---|---|---|
ReplyCode | String | 响应码 |
ReplyMessage | String | 响应消息提示 |
ReplyDataType | Integer | 响应数据类型,可忽略 |
ReplyObject | Array | 响应数据,详细信息参考示例说明 |
响应示例:
{
"ReplyCode": "Success",
"ReplyMessage": "成功",
"ReplyDataType": 0,
"ReplyObject": {
"Authorization": "",// Token值
"UserGuid": "", // 用户唯一GUID
"UserRole": 1 // 用户角色:0操作员,1临时管理员,2超级管理员,3浏览员
},
"TotalRowCount": 0,// 可忽略,分页查询的总行数
"AlarmCount": 0,// 可忽略
"PageCount": 0 // 可忽略,分页查询的总页数
}