萤石平台接口使用说明文档.pdf

《萤石平台接口使用说明文档.pdf》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、TableofContentsIntroduction1.1FirstChapter1.21Introduction萤石平台接口使用说明文档第一章概述本文档用于说明私有云调用萤石云接口方法，主要分三部分进行相关内容定义和介绍。第一部分概述，主要介绍本文档结构和主要内容。第二部分主要介绍萤石云HTTP连接请求和安全策略，对HTTP请求格式、应答格式、签名算法等做了详细介绍，并列举实例进行相关说明。第三部分主要介绍萤石云平台开放接口规范细则，从接口功能、定义和范例三方面对接口做了详细规定并给出使用范例。最后对有关专业用语做了名词解释，便于理解文档内容。第二章萤石云HTTP连接请求和安全策略2.

2、1萤石云HTTP连接请求2.1.1功能描述用户通过HTTP请求方式，从私有云调用萤石云开放接口，实现获取设备列表、查询报警信息、获取视频广场栏目和展示视频列表等功能。2.1.2HTTP请求数据格式规范HTTP请求URL约定如下：服务类型域名备注说明HTTPPOST请求https://open.ys7.com/api/method所有接口统一用该请求url注：不要将url中的method替换成接口中的接口名称!HTTP请求数据json格式定义如下：2Introduction参数名描述systemver协议版本号sign签名值key开放平台appkey值timeUTC时间戳，自1970年1月1

3、日起计算的时间，单位为秒methodHTTP请求执行方法:,params.....HTTP方法使用的参数集合:id请求消息id号，同步调用时传入任意整数值system：系统参数集合ver：协议版本信息，当前为1.0sign：签名值，服务端用来做签名校验key：appkey在萤石云开放平台（open.ys7.com）注册申请后由萤石云平台统一颁布，与之匹配的secret值用来做签名校验。针对于每一个应用，都需要在萤石云平台上申请自己使用的appkey及secrettime：请求时私有云的时间戳(UTC),私有云要与萤石开平同步时间（两者时间不能相差

4、超过5分钟）。如果私有云时间与萤石开平的时间相差超过5分钟，将会返回10010错误码。method：HTTP请求执行方法params：method使用的参数attr：属性名称val：属性值id：消息序列号，传入任意整数即可2.1.3HTTP应答数据格式规范参数名描述id返回消息id号，与请求id相同resultmsg返回消息串code返回值pagesize分页大小total总数:,data.....HTTP方法返回的参数:3Introduction2.1.4服务端返回值定义返回返回信息备注值200操作成功1001用户名不合法1002用户名已被占用

5、1003密码不合法1004密码为同一字符1005密码错误次数过多1006手机号码已经被注册1007手机号未注册1008手机号码不合法1009用户名与手机不匹配1010获取验证码失败1011验证码错误1012验证码失效1013用户不存在1014密码不正确1015用户被锁住1021验证参数异常1026邮箱已经被注册1031邮箱未注册1032邮箱不合法1041获取验证码过于频繁手机验证码输入错误超过规1043定次数2000设备不存在2001摄像机不存在2003设备不在线2004设备异常2007设备序列号不正确2009设备请求响应超时异常4Introduction2030设备不支持5000设备已被

6、自己添加5001设备已被别人添加5002设备验证码错误7001邀请不存在7002邀请验证失败7003邀请用户不匹配7004无法取消邀请7005无法删除邀请7006不能邀请自己7007重复邀请10001参数错误参数为空或者格式不对10002accessToken异常或过期10004用户不存在确认appKey状态，不通过或者冻结状态会10005appKey异常返回该错误码10006ip受限10007调用次数达到上限①获取签名方式详见apidemo②注意编码格10008签名错误式为UTF-810009签名参数错误签名超时（需要调用3.6接10010口同步服务器时间）10011未开通萤石云服务参照

7、绑定流程第三方账户与萤石账号已经10012绑定10013应用没有权限调用此接口APPKEY下对应的第三方10014userId和phone未绑定10017appKey不存在AccessToken与Appkey不10018匹配10019密码错误10020请求方法为空5Introduction20001通道不存在20002设备不存在20003参数异常，SDK版本过低20004参数异常，SDK版本过低安全认证失败，需进行SDK