监控平台接口文档.doc

监控平台接口文档 作者 版本 修改日期 备注 刘洋 2016-1-18 蔡文勇 2016-03-07 夏祥均 2016-05 刘洋 2016-7-22 修缮 目录 目录 2 1.文档说明 3 1.1. 接口说明 3 1.2. 接口命名规则 3 1.3. 术语与缩写解释 3 2.监控平台接口 4 2.1 检测账号是否存在（0721） 4 2.2 创建账号（0513） 4 2.3 获取用户列表（0513） 4 2.4 删除账号 5 2.5 重置密码 5 2.6获取设备列表 5 2.7 获取设备型号列表 6 2.8 添加设备（0513） 6 2.9 删除设备（0513） 7 2.10 修改设备/通道名称 7 2.11 新增通道给用户 8 2.12 删除用户通道 8 2.13 获取设备平台号 8 2.14 获取账号授权码 9 2.15 重置授权码 9 2.16 申请在线观看 9 2.17 获取视频截图 10 3.错误列表(待定) 10 4.设备型号定义 11 1.文档说明 接口说明 1）第三方请求和回应的参数都采用JSON的格式，并且是ssl连接 2）通迅采用http post协议header_name header_value description Accept application/json 服务器端返回给客户端的数据类型 Content-Type application/ 客户端发到服务器端的是数据类型 Authorization 由平台关产生的api token, 用来标识第三方应用，第三方应用需要保管好，防止泄漏， 泄漏后需要在平台重置这个api token 调用示例： 添加用户： http://ip:port/openapi/account/add 接口命名规则 接口名称采用字母小写命名规则，多个单词用下划线’_’分隔 术语与缩写解释 缩写、术语 解 释 2.监控平台接口 2.1 检测账号是否存在（0721） 调用模式 - apiSvr 模块路径 接口参数 * string 用户 返回数据 * ret int 0-成功，!0-失败 * msg string 返回说明 补充说明 A 2.2 创建账号（0513） 调用模式 - apiSvr 模块路径 接口参数 * string 用户 * password string 密码 int 0: 企业账号, 1: 企业内员工账号, 2: 个人账号 ! parent_account string 如果为企业员工账号，则必须指定父账号，其它类型无效 返回数据 * ret int 0-成功，!0-失败 * msg string 返回说明 * string 账号客户端登录授权码 补充说明 A 2.3 获取用户列表（0513） 调用模式 - apiSvr 模块路径 ！ keyword_account string 查询关键字 * page_num int 页码 * page_size int 每页条目（默认10） 返回数据 * ret int 0-成功，!0-失败 * msg tring 返回说明 * size int 总条目数 * page_size int 当前页条目数 * page int 当前页码 ! list Array(json) * account string 用户账号 * created_time datetime 创建时间 * type int 账号类型 ! parent_account string 父账号 补充说明 调用模式 - apiSvr 模块路径 接口参数 * string 用户 返回数据 * ret int 0-成功，!0-失败 * msg tring 返回说明 补充说明 调用模式 - apiSvr 模块路径 接口参数 * string 用户 * password string 用户密码 返回数据 * ret int 0-成功，!0-失败 * msg tring 返回说明 补充说明 调用模式 - apiSvr 模块路径 接口参数 * string 用户账号 ！ keyword_device_name string 查询关键字 * page_num int 页码 * page_size int 每页条目（默认10） 返回数据 * ret int 0-成功，!0-失败 * msg tring 返回说明 * size int 总条目数 * page_size int 当前页条目数 * pag