整体机制
整个系统采取 用户-网关-测量设备 三层概念,每一层都提供对应的API来让用户方便获取或更新数据,满足不同种类的物联网应用。
授权机制
用户注册成功后会分配一个Userkey,在调用需要授权的API时,需要在HTTP的Header中增加 userkey:您的userkey,用Curl举例,如下:
curl --request POST http://www.lewei50.com/api/V1/Gateway/UpdateSensors/01 --data "[{'Name':'T1','Value':'23'}]" --header "userkey:2c59c80b372exxxxxxe1632b99227899"
Userkey可以在我的账户->个人信息中找到,如图所示
调用机制
1.HTTP类型分为两种:Post和Get,Get方式直接在Url增加参数即可,处理Post方式,需要根据API参考的格式Post对应的数据,用Curl举例 -request POST --data [{"Name":"T1","Value":“23"}]
2.返回格式均为Json,参照API参考获知各字段信息
API参考
目前API分为3个大类,用户可以在对应大类中方便找到自己需要的API,每个API都包含如下实例所示信息:
gateway/updateSensors
上传测量设备数据
URL
http://www.lewei50.com/api/v1/gateway/updatesensors/{网关标识}
是否需要Userkey
是
URL请求参数
无
HTTP请求方式
POST
Post数据实例
[ { "Name":"T1", "Value":"1" }, { "Name":"01H1", "Value":"96.2" }]
Post数据格式说明
必选 | 类型 | 说明 | |
---|---|---|---|
Name | 是 | string | 测量设备标识 |
Value | 是 | string | 测量设备当前值 |
返回格式
JSON
返回结果实例
{ "Successful": true, "Message": null}
返回字段说明
字段 | 字段类型 | 说明 |
---|---|---|
Successful | boolean | 是否上传成功 |
Message | string | 上传出错时的错误信息 |
注意事项&详细说明
注意区分大小写
在线调试工具
API测试
我们为每个API提供了在线测试工具,用户可以通过点击API参考中的在线测试工具链接打开测试页面,如图所示:
需要注意:对于Url中http://www.lewei50.com/api/V1/gateway/UpdateSensors/{网关标识}大括号中间的内容需要替换成用户真实的数据。
右侧会列出Request和Response的详细数据,方便用户参考。
如果你需要更详细的技术交流或者疑问咨询,可以加入乐为物联技术支持群:59162154;或关注乐为物联新浪微博@乐为物联;
关注乐联网微信:搜索公众账号“乐联网”。或者扫描下面的二维码来添加关注“乐联网”。