物联网云平台对外数据接口(PDF40页).pdf

《物联网云平台对外数据接口(PDF40页).pdf》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、浙江托普云农科技股份有限公司致力于农业信息化的发展物联网云平台对外数据接口设计说明书文件状态文件标示研发部【】初稿当前版本V1.2【√】修改作者谢朝明【】发布日期2015-07-22研发部内部文档1浙江托普云农科技股份有限公司致力于农业信息化的发展修订历史记录日期版本说明作者2015-07-22设计初稿谢朝明2015-07-23修改稿宁应财2015-07-23修正修改，增加设备控制的定时控制参数，增加通过谢朝明终端获取所有传感器和控制设备协议，获取最后一组数据协议，修改部分参数

2、名称2015-10-08增加地块及地块相关数据查询功能陈旭研发部内部文档2浙江托普云农科技股份有限公司致力于农业信息化的发展1简介物联网子系统对外服务接口是物联网系统平台对外部终端设备或第三方应用调用本系统的功能服务接口。2接口使用注意事项1、接口标准符合Rest风格2、Get方式表示获取,Post方式表示添加，Put方式表示修改，Delete方式表示删除。当有不支持Put或Delete方式的客户端时，可使用Post代替，在URL后面增加参数_method服务端可自动转为Put或Delete方式。3、

3、使用Get方式时需要注意对参数URLEncode4、使用格式http://{url}/api/{版本}/{资源}/{动作}或者http://{url}/api/{版本}/{资源}/{id}"id"为整数，表示对某一个资源的一个编号所对应的记录的操作。5、需要登录的操作在URL后增加ut参数来表示用户令牌的字符串。6、使用统一的格式返回{"code":"10100a","msg":"错误信息","result":{JsonObject}}7、code为"0"时表示执行成功，其他六位编码为状态码，使用16进制字符串，

4、如10057e等，错误编码有英文字母存在的则全为小写。msg为状态描述，当借口需要数据返回时Result为JsonObject或JsonArray，当操作无数据返回时则该参数在返回对象中不存在。3接口说明注意所有的数据返回的格式是指{"code":"10100a","msg":"错误信息","result":{JsonObject}}中的JsonObject的数据内容。研发部内部文档3浙江托普云农科技股份有限公司致力于农业信息化的发展3.1登录接口说明：用户登录有效期为2小时。接口URLhttp://wlw.zj

5、tpyun.com/openapi/v1/user/loginHTTP方法POST返回格式JSON授权/登录不需要相关说明用户登陆传入参数参数类型必选可空默认值说明示例user_nameSTRING必须不可空用户名myusertestpasswordSTRING必须不可空Md5加密后的密码y6r7uej34示例{"user_name":"myusertest","password":"y6r7uej34"}登录成功返回结果参数类型必选可空默认值说明示例user_tokenSTRING必须不可空用户令牌D58E35

6、82AFA99040E27B92B13C8F2280user_idINT必须不可空用户id1示例{"user_token":"D58E3582AFA99040E27B92B13C8F2280","user_id":1}3.2获取终端下所有设备说明：用户必须先登录才能获取数据。接口URLhttp://wlw.zjtpyun.com/openapi/v1/terminal/{id}/deviceHTTP方法GET研发部内部文档4浙江托普云农科技股份有限公司致力于农业信息化的发展返回格式JSON授权/登录需要相关说明获

7、取终端下的所有设备传入参数通过URL传递参数参数类型必选可空默认值说明示例{id}INT必须不可空终端id1示例/openapi/v1/terminal/1/device返回结果参数类型必选可空默认值说明示例countINT必须不可空数据总条数1data_arrayJSONArr必须不可空┣━device_idINT必须不可空设备编号（可用在传感1器的sensor_id或控制设备的ctrl_device_id）┣━device_type_idINT必须不可空设备类型编号见附录1┣━sensor_type_idIN

8、T必须不可空传感器类型编号见附录161当非传感器类型时为0示例{"count":1,"data_array":[{"device_id":1,"device_type_id":1,"sensor_type_id":161}]研发部内部文档5浙江托普云农科技股份有限公司致力于农业信息化的发展}3.3获取终端下的最后一组数据说明：用户必须先登录才能获取数据。接口URLhttp