监控平台接口.doc

监控平台接口文档 作者 版本 修改日期 备注 刘洋 2016-1-18 蔡文勇 2016-03-07 夏祥均 2016-05 刘洋 2016-7-22 修缮 目录 TOC \* MERGEFORMAT 目录 PAGEREF _Toc456961370 \h 2 1.文档说明 PAGEREF _Toc456961371 \h 3 1.1. 接口说明 PAGEREF _Toc456961372 \h 3 1.2. 接口命名规则 PAGEREF _Toc456961373 \h 3 1.3. 术语与缩写解释 PAGEREF _Toc456961374 \h 3 2.监控平台接口 PAGEREF _Toc456961375 \h 4 2.1 检测账号是否存在（0721） PAGEREF _Toc456961376 \h 4 2.2 创建账号（0513） PAGEREF _Toc456961377 \h 4 2.3 获取用户列表（0513） PAGEREF _Toc456961378 \h 4 2.4 删除账号 PAGEREF _Toc456961379 \h 5 2.5 重置密码 PAGEREF _Toc456961380 \h 5 2.6获取设备列表 PAGEREF _Toc456961381 \h 5 2.7 获取设备型号列表 PAGEREF _Toc456961382 \h 6 2.8 添加设备（0513） PAGEREF _Toc456961383 \h 6 2.9 删除设备（0513） PAGEREF _Toc456961384 \h 7 2.10 修改设备/通道名称 PAGEREF _Toc456961385 \h 7 2.11 新增通道给用户 PAGEREF _Toc456961386 \h 8 2.12 删除用户通道 PAGEREF _Toc456961387 \h 8 2.13 获取设备平台号 PAGEREF _Toc456961388 \h 8 2.14 获取账号授权码 PAGEREF _Toc456961389 \h 9 2.15 重置授权码 PAGEREF _Toc456961390 \h 9 2.16 申请在线观看 PAGEREF _Toc456961391 \h 9 2.17 获取视频截图 PAGEREF _Toc456961392 \h 10 3.错误列表(待定) PAGEREF _Toc456961393 \h 10 4.设备型号定义 PAGEREF _Toc456961394 \h 11 1.文档说明 接口说明 1）第三方请求和回应的参数都采用JSON的格式，并且是ssl连接 2）通迅采用http post协议 3）第三方操作时需要在HTTP的head区指定如下字段 header_name header_value description Accept application/json 服务器端返回给客户端的数据类型 Content-Type application/json 客户端发到服务器端的是数据类型 Authorization $Token 由平台关产生的api token, 用来标识第三方应用，第三方应用需要保管好，防止泄漏， 泄漏后需要在平台重置这个api token 调用示例： 添加用户： http://ip:port/openapi/account/add 接口命名规则 接口名称、参数、返回值均采用字母小写命名规则，多个单词用下划线’_’分隔 参数前面符号：* 表示内容必填项；! 表示内容可选项； 术语与缩写解释 缩写、术语 解 释 app 第三方应用 apiSvr 监控平台公用api服务 2.监控平台接口 2.1 检测账号是否存在（0721） 调用模式 app - apiSvr 模块路径 /openapi/account/check_account 接口参数 * account string 用户账号 返回数据 * ret int 0-成功，!0-失败（ HYPERLINK \l _三、错误列表(待定) 错误代码） * msg string 返回说明 补充说明 Account规则：4-24字符 返回值0：表示该账号不存在 非0：表示Error或该账号存在 2.2 创建账号（0513） 调用模式 app - apiSvr 模块路径 /openapi/account/add 接口参数 * account string 用户账号 * password string 密码 * type int 0: 企业账号, 1: 企业内员工账号, 2: 个人账号 ! parent_account string 如果为企业员工账号，则必须指定父账号