1. 首页
  2. IT资讯

yitai json rpc 文档

益泰安防远程调用接⼝文档
Contents
1 概述 1 1.1 接⼝描述 1.1.1 请求 1.1.2 应答 1.1.3 通知 1.2 HTTP请求 1.3 示例
2 接⼝定义 2 2.1 用户接⼝ 2.1.1 用户登录验证 2.1.2 获取用户信息 2.1.3 设置用户信息 2.2 设备接⼝ 2.2.1 获取设备列表 2.2.2 获取设备状态 2.2.3 布防撤防设备 2.2.4 获取绑定的手机号 2.3 视频接⼝ 2.3.1 获取摄像头地址 2.4 其他 2.4.1 获取警报消息3 其他 3.1 服务器地址
1 概述
1.1 接⼝描述 益泰安防系统提供JSON格式的远程调用接⼝(RPC),符合JSON-RPC 1.0规范,包括 请求、应答和通知三种类型。
1.1.1 请求 请求由客户端发送至服务器端,包括如下三个属性: method 远程调用函数名,字符串类型 params 调用参数,数组类型 id 请求id,可以为任意类型,用来和服务器应答匹配
1.1.2 应答 应答由服务器端返回给客户端,同样包括三个属性: result 服务器端应答内容,如果出错则为空值 error 服务器端的错误消息,如果有 result 返回,则为空 id 与请求id匹配的值
1.1.3 通知 通知是⼀种无需应答的特殊请求: id 空值 1.2 HTTP请求 请求消息需要用POST方式提交,Content-Type类型为 application/json
1.3 示例 下边是⼀段JSON-RPC的消息示例: –&gt {“method”:”login”,”params”:[“test”,”098f6bcd4621d373cade4e832627b4f6″],”id”:1} <-- {"result":true,"error":null,"id":1} --&gt {"method":"getDeviceList","params":null,"id":2} <-- {"result":[{"device":1234,"address": "Some Address"}],"error":null,"id":2}
2 接⼝定义 2.1 用户接⼝ 2.1.1 用户登录验证 方法名 login 参数列表 参数名称 说明 imei 手机码 返回值 返回值 说明 用户ID 验证用户名、密码成功 false 验证失败
示例 –&gt {“method”:”login”,”params”:[“098f6bcd4621d37″],”id”:1} <-- {"result":12,"error":null,"id":1}
用户注册 方法名 reg 参数列表 参数名称 说明 username 用户名 password md5加密过的新密码,空值表示不修改 email 新邮箱,空值表示不修改 phone 新手机号,空值表示不修改 address 新住址,空值表示不修改 imei 手机码 返回值 返回值 说明 true 验证用户名、密码成功 false 验证失败
示例 –&gt {“method”:”login”,”params”:[“username”,”password”,”email”,”phone”,”address”,”imei”],”id”:1} <-- {"result":12,"error":null,"id":1}
2.1.2 获取用户信息 方法名 getUserProfile 参数列表 参数名称 说明 imei 手机码 返回值 { “username”: 登录名, “realname”: 真实姓名, “email”: 电子邮箱, “phone”: 手机号, “address”: 用户住址, “location”: 用户所在地区 } 示例 –&gt {“method”:”getUserProfile”,”params”:[],”id”:2} <-- {"id":2,"result":{"username":"test_1","realname":"Guest", "email":"abc@abc.com","phone":"13800138000", "address":"undefined address","location":"Beijing"}, "error":null}
2.1.3 设置用户信息 方法名 setUserProfile 参数列表 参数名称 说明 password md5加密过的新密码,空值表示不修改 email 新邮箱,空值表示不修改 phone 新手机号,空值表示不修改 address 新住址,空值表示不修改 imei 手机码 返回值 返回值 说明 true 设置成功 false 设置失败 示例 –&gt {“method”:”setUserProfile”,”params”:[null,”a@b.com”, “13800111000”,”my address”],”id”:3} <-- {"id":3,"result":true,"error":null}
2.2 设备接⼝ 2.2.1 获取设备列表 方法名 getDeviceList 参数参数 参数名称 说明 imei 手机码 返回值 [ {“device”: 设备编号, “address”: 设备地址}, {“device”: 设备编号, “address”: 设备地址}, … ] 示例 –&gt {“method”:”getDeviceList”,”params”:[],”id”:4} <-- {"id":4,"result":[{"device":"1097","address":"device address"}], "error":null}
2.2.2 获取设备状态 方法名 getDeviceStatus 参数列表 参数名称 说明 device 设备编号 imei 手机码 返回值 返回最近的20次状态值, up_time 为 Unix Timestamp ] {“status”: 状态, “up_time”: 状态变更时间}, {“status”: 状态, “up_time”: 状态变更时间}, … [ 示例 –&gt {“method”:”getDeviceStatus”,”params”:[1008000],”id”:5} <-- {"id":5,"result":[{"status":"u8bbeu5907u79bbu7ebf", "up_time":"1286752447"},{"status":"u5e03u9632u72b6u6001", "up_time":"1286761969"}],"error":null}
2.2.2 获取用户信息,设备列表,设备状态 方法名 getInfoEx 参数列表 参数名称 说明 device 设备编号 imei 手机码 返回值数组 三个元素 分别是上面三个接口的返回值
2.2.3 布防撤防设备 方法名 setDeviceDefence 参数列表 参数名称 说明 device 设备编号 defend 是否布防: true 表示布防, false 表示撤防 imei 手机码 返回值 返回值 说明 true 操作成功 false 操作失败 示例 –&gt {“method”:”setDeviceDefence”,”params”:[1008000,true],”id”:6} <-- {"id":6,"result":true,"error":null}
2.2.3 获取设备布防撤防状态方法名getDeviceDefendStatus参数列表参数名称 说明device 设备编号 imei 手机码返回值返回设备布防撤防状态,有三种状态:返回值 说明-1 设备离线0 撤防状态1 布防状态示例–&gt {“method”:”getDeviceDefendStatus”,”params”:[1008000],”id”:15}<-- {"id":15,"result":0,"error":null}
2.2.4 获取绑定的手机号 方法名 getBindPhones 参数列表 参数名称 说明 device 设备编号 imei 手机码 返回值 [ {“phone”: 手机号, “alarm-types”: 报警类型}, {“phone”: 手机号, “alarm-types”: 报警类型}, … ]
报警类型是个字符串,类型中间使用逗号分割,类型包括如下内容: 类型名 说明 urgency 紧急报警 door 门磁报警 infra 红外报警 window 窗磁报警 help 紧急求助 smoke 烟感报警 gas 煤气报警 glass 玻璃震动报警 water 水浸报警 defen 布防撤防 示例 –&gt {“method”:”getBindPhones”,”params”:[11508],”id”:7} <-- {"id":7,"result":[{"phone": 15511281102, "alarm-types": "urgency,door,defen"}],"error":null}
2.2.5 绑定手机号到设备方法名setBindPhone参数列表参数名称 说明device 设备编号phone 手机号alarm-types 报警类型,由关联数组表示报警类型是一个关联数组,其中关键字是类型名,值是0/1,表示设置或取消该类 型的报警。报警类型说明如下:类型名 说明urgency 紧急报警door 门磁报警infra 红外报警window 窗磁报警help 紧急求助smoke 烟感报警gas 煤气报警glass 玻璃震动报警water 水浸报警defen 布防撤防 imei 手机码返回值返回值 说明true 绑定成功false 绑定失败– 当绑定的手机号超过默认最大值(默认为10),会返回错误。– 当绑定的手机号为新号码的时候,会增加一条记录。– 当绑定的手机号已经存在,会修改相应的报警类型。示例–&gt {“method”:”setBindPhone”,”params”:[1008000,”15511281102″,{“urgency”:1,”help”:0}],”id”:17}<-- {"id":17,"result":true,"error":null}
2.2.6 删除绑定的手机号方法名delBindPhone参数列表参数名称 说明device 设备号phone 手机号 imei 手机码返回值返回值 说明true 删除成功false 删除失败示例–&gt {“method”:”delBindPhone”,”params”:[1008000,”15511281102″],”id”:18}<-- {"id":18,"result":true,"error":null}
2.2.8 获取设备地址方法名getDeviceAddress参数列表参数名称 说明device 设备号返回值返回设备地址,如果返回 false 表示查询地址失败示例–&gt {“method”:”getDeviceAddress”,”params”:[1008000], “id”:19}<-- {"id":19,"result":"Device Address","error":null}
2.2.9 设置设备地址方法名setDeviceAddress参数列表参数名称 说明device 设备号address 地址返回值返回值 说明true 设置地址成功false 设置地址失败 示例–&gt {“method”:”setDeviceAddress”,”params”:[1008000,”New Address”],”id”:29}<-- {"id":29,"result":true,"error":null}
2.2.10 获取设备告警信息方法名getDeviceRecentAlarm参数列表参数名称 说明device 设备号count 告警信息条数返回值返回设备最近 count 个告警信息标识,有如下状态:状态标识 说明urgency 紧急告警help 紧急求助door 门磁告警window 窗磁告警infra 红外告警water 水浸告警smoke 烟感告警gas 瓦斯煤气告警glass 玻璃震动告警
–&gt {”method”:”getDeviceRecentAlarm”,”params”:[1008000, 2],”id”:22}<-- {”id”:22,”result”:[[”door”,1286752447],[”window”, 1286721349]],”error”:null}
2.2.11 获取设备控制信息方法名getDeviceRecentDefend参数列表参数名称 说明device 设备号count 控制信息条数返回值返回设备最近 count 个控制信息标识,有如下控制标识:控制信息标识 说明button-defend 遥控器布防button-undefend 遥控器撤防web-defend 网页布防web-undefend 网页撤防sms-defend 短信布防sms-undefend 短信撤防app-defend 客户端布防app-undefend 客户端撤防
–&gt {”method”:”getDeviceRecentDefend”,”params”:[1008000, 2],”id”:23}<-- {”id”:23,”result”:[[”button-defend”,1286852447],[”app-undefend”,1286821349]], ”error”:null}
2.2.12 获取主机运行状态方法名getDeviceRecentOnline参数列表参数名称 说明device 设备号count 主机状态查询条数返回值返回设备最近 count 个主机状态的变更消息,有如下状态标识:控制信息标识 说明offline 设备离线reset 设备重启heart 心跳
–&gt {”method”:”getDeviceRecentOnline”,”params”:[1008000, 2],”id”:24}<-- {”id”:24,”result”:[[”offline”,1286952447],[”reset”,1286991349]], ”error”:null}
2.3 视频接⼝ 2.3.1 获取摄像头地址 方法名 getVideoUri 参数列表 参数名称 说明 imei 手机码 返回值 摄像头链接地址 示例
2.3.1 获取视频地址方法名getVideos
参数列表参数名称 说明devid 设备IDcount 返回数量imei 手机码返回值返回值 说明[{mp4_count:1,3gp_count:1,pic_count:3,url:”http://www.server.com/path/path/videoid2″},{mp4_count:1,3gp_count:1,pic_count:3,url:”http://www.server.com/path/path/videoid1″}]
mp4_count MP4 文件的数量3gp_count 3GP 文件的数量pic_count 图片文件的数量 JPG
url 文件的URL , 不带扩展名
完整的URL
一个文件http://www.server.com/path/path/videoid.mp4http://www.server.com/path/path/videoid.3gphttp://www.server.com/path/path/videoid.jpg多个文件http://www.server.com/path/path/videoid_0.jpghttp://www.server.com/path/path/videoid_1.jpghttp://www.server.com/path/path/videoid_2.jpg
示例–&gt {“method”:”getVideos”,”params”:[“123″,”1″],”id”:1}<-- {"result":[{mp4_count:1,3gp_count:1,pic_count:5,url:"http://www.server.com/path/path/videoid"}],"error":null,"id":1}
2.3.2 获取视频地址 (2010-12-21 add)方法名getVideos2
参数列表参数名称 说明devid 设备IDcreatetime 记录时间(long)imei 手机码返回值返回值 说明[{mp4_count:1,3gp_count:1,pic_count:3,url:”http://www.server.com/path/path/videoid2″}]
mp4_count MP4 文件的数量3gp_count 3GP 文件的数量pic_count 图片文件的数量 JPG
url 文件的URL , 不带扩展名
完整的URL
一个文件http://www.server.com/path/path/videoid.mp4http://www.server.com/path/path/videoid.3gphttp://www.server.com/path/path/videoid.jpg
示例–&gt {“method”:”getVideos”,”params”:[“123″,”1″],”id”:1}<-- {"result":[{mp4_count:1,3gp_count:1,pic_count:5,url:"http://www.server.com/path/path/videoid"}],"error":null,"id":1}
2.4 其他 2.4.1 获取警报消息 方法名 checkAlarmMessage 参数列表 参数名称 说明 imei 手机码 返回值 报警消息 示例
3 其他 3.1 服务器地址 http://video.ehomeonline.com.cn:8000/mobileapi/jsonrpc

来自 “ ITPUB博客 ” ,链接:http://blog.itpub.net/27042095/viewspace-754603/,如需转载,请注明出处,否则将追究法律责任。

主题测试文章,只做测试使用。发布者:布吉卡,转转请注明出处:http://www.cxybcw.com/196107.html

联系我们

13687733322

在线咨询:点击这里给我发消息

邮件:1877088071@qq.com

工作时间:周一至周五,9:30-18:30,节假日休息

QR code