监控平台接口文档

《监控平台接口文档》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、监控平台接口文档作者版本修改日期备注刘洋2016-1-18蔡文勇2016-03-07夏祥均2016-05刘洋2016-7-22修缮目录目录21.文档说明31.1.接口说明31.2.接口命名规则31.3.术语与缩写解释32.监控平台接口42.1检测账号是否存在（0721）42.2创建账号（0513）42.3获取用户列表（0513）42.4删除账号52.5重置密码52.6获取设备列表52.7获取设备型号列表62.8添加设备（0513）62.9删除设备（0513）72.10修改设备/通道名称72.11新增通道给用户82.12删除用户通道82.13获取设备平台号82.14获取账号

2、授权码92.15重置授权码92.16申请在线观看92.17获取视频截图103.错误列表(待定)104.设备型号定义111.文档说明1.1.接口说明1）第三方请求和回应的参数都采用JSON的格式，并且是ssl连接2）通迅采用httppost协议3）第三方操作时需要在HTTP的head区指定如下字段header_nameheader_valuedescriptionAcceptapplication/json服务器端返回给客户端的数据类型Content-Typeapplication/json客户端发到服务器端的是数据类型Authorization$Token由平台关产生的a

3、pitoken,用来标识第三方应用，第三方应用需要保管好，防止泄漏，泄漏后需要在平台重置这个apitoken调用示例：添加用户：http://ip:port/openapi/account/add1.2.接口命名规则1）接口名称、参数、返回值均采用字母小写命名规则，多个单词用下划线’_’分隔2）参数前面符号：*表示内容必填项；!表示内容可选项；1.3.术语与缩写解释缩写、术语解释app第三方应用apiSvr监控平台公用api服务2.监控平台接口2.1检测账号是否存在（0721）调用模式app->apiSvr模块路径/openapi/account/check_accoun

4、t接口参数*accountstring用户账号返回数据*retint0-成功，!0-失败（错误代码）*msgstring返回说明补充说明Account规则：4-24字符返回值0：表示该账号不存在非0：表示Error或该账号存在2.2创建账号（0513）调用模式app->apiSvr模块路径/openapi/account/add接口参数*accountstring用户账号*passwordstring密码*typeint0:企业账号,1:企业内员工账号,2:个人账号!parent_accountstring如果为企业员工账号，则必须指定父账号，其它类型无效返回数据*ret

5、int0-成功，!0-失败（错误代码）*msgstring返回说明*authstring账号客户端登录授权码补充说明Account规则：4-24字符注意：type类型的企业账号不能创建个人账号，只能创建企业员工账号2.3获取用户列表（0513）调用模式app->apiSvr模块路径/openapi/account/list！keyword_accountstring查询关键字*page_numint页码*page_sizeint每页条目（默认10）返回数据*retint0-成功，!0-失败*msgstring返回说明*sizeint总条目数*page_sizeint当前页

6、条目数*pageint当前页码!listArray(json)*accountstring用户账号*created_timedatetime创建时间*typeint账号类型!parent_accountstring父账号补充说明2.4删除账号调用模式app->apiSvr模块路径/openapi/account/del接口参数*accountstring用户账号返回数据*retint0-成功，!0-失败*msgstring返回说明补充说明2.5重置密码调用模式app->apiSvr模块路径/openapi/account/ret_pwd接口参数*accountstring

7、用户账号*passwordstring用户密码返回数据*retint0-成功，!0-失败*msgstring返回说明补充说明2.6获取设备列表调用模式app->apiSvr模块路径/openapi/device/list接口参数*accountstring用户账号！keyword_device_namestring查询关键字*page_numint页码*page_sizeint每页条目（默认10）返回数据*retint0-成功，!0-失败*msgstring返回说明*sizeint总条目数*page_sizeint当前页条目数