适用SKY系列终端,包含SKY X510、SKY X310、SKY 310i、SKY 310、SKY D510i、SKY D510、SKY X700、SKY X500、SKY X300、SKY 300、SKY 100
API使用必须先调用登陆接口(/mtapi/entity/connect)获取到userid之后,才能调用其他接口
API使用须将发送的结构体填充完整,整个结构分为head和body两部分,body为API请求示例的内容,head为固定的几个参数如下:
(特别说明:head部分五个字段必须全部包含)
字段 |
含义 |
sessionid |
必填0 |
userid |
调用登陆接口登陆成功之后的返回值 |
webapiversion |
webapi版本号(必填2)(该字段为后续版本兼容使用) |
seqid |
填null |
synchronous |
后端接受消息之后是否立即响应(一般填true) |
完整的结构(以登陆接口为例):
示例参数:
参数名称 | 类型 | 说明 |
---|---|---|
param1 | string | 用户名 |
param2 | string | 密码(要md5加密后的结果,32位小写) |
param3 | boolean | 是否要抢登(true,false) |
param4 | string | 登陆浏览器类型(IE7,IE8,IE9,IE10,IE11,firefox,Opera,Safari,Chrome,Edge,other) |
返回结果:
结果参数:
参数名称 | 类型 | 说明 |
---|---|---|
achCurUserIP | string | 当前用户IP |
achUserId | string | 登录用户的userid |
achUserName | string | 用户名 |
bIsKickOut | boolean | 是否有其他用户登录(true/false) |
bLogin | boolean | 登录结果(true:成功 false:失败) |
bNameExist | boolean | 登陆名是否存在(true/false) |
bSameBrowser | boolean | 是否使用相同浏览器登录(true/false) |
dwLoginErrCnt | int | 登陆失败次数 |
dwLoginTime | int | 距离最近一次账号被锁定时间 |
dwUserRight | int | 用户权限 1:管理员;2:操作员(默认) |
emMtModel | int | 终端类型 |
注意事项:
1、emMtModel枚举值参考左上角枚举值汇总的EmMtModel_Api
2、参数说明中如果有是否字样表示该字段使用布尔值(0,1)或者(false,true)