阿里云物联网平台HTTP连接通信

最新推荐文章于 2024-07-03 17:42:45 发布

armcsdn

最新推荐文章于 2024-07-03 17:42:45 发布

阅读量4k

点赞数

分类专栏：物联网阿里云文章标签： 1024程序员节

原文链接：https://help.aliyun.com/document_detail/58034.html?spm=a2c4g.11186623.2.15.362b6405jgcqq7#concept-djd-vt5-wdb

版权

物联网同时被 2 个专栏收录

13 篇文章 1 订阅

订阅专栏

阿里云

2 篇文章 0 订阅

订阅专栏

HTTP连接通信

更新时间：2020-10-21 15:14:22

编辑我的收藏

本页目录

物联网平台支持使用HTTP接入，目前仅支持HTTPS协议。下面介绍使用HTTP连接通信的接入流程。

限制说明

仅华东2（上海）、华北2（北京）、华南1（深圳）地域支持HTTP通信。
仅支持HTTPS协议。
适合单纯的数据上报场景，数据上行接口传输的数据大小限制为128 KB。
Topic规范和MQTT的Topic规范一致，可以复用MQTT连接通信的Topic。使用HTTP协议连接，上报数据请求：${endpoint}/topic/${topic}。不支持以?query_String=xxx格式传参。
HTTP请求只支持POST方式。
设备认证返回的token会在一定周期后失效。目前token有效期是7天，请务必考虑token失效逻辑的处理。

接入流程

接入流程主要包含进行设备认证以获取设备token和采用获取的token进行持续地数据上报。

认证设备，获取设备的token。 Endpoint地址：

对于您购买的实例，接入域名请在物联网平台控制台，找到对应的实例，单击实例进入实例详情查看。
华东2（上海）地域，公共实例的Endpoint地址为https://iot-as-http.cn-shanghai.aliyuncs.com。

认证设备请求：

POST /auth HTTP/1.1
Host: ${YourEndpoint}
Content-Type: application/json
body: {"version":"default","clientId":"mylight1000002","signmethod":"hmacsha1","sign":"4870141D4067227128CBB4377906C3731CAC221C","productKey":"ZG1EvTE****","deviceName":"NlwaSPXsCpTQuh8FxBGH","timestamp":"1501668289957"}

表 1. 参数说明
参数	说明
Method	请求方法，只支持POST方法。
URL	URL地址，只支持HTTPS，取值：/auth。
Host	Endpoint地址。
Content-Type	设备发送给物联网平台的上行数据的编码格式，目前只支持application/json。若使用其他编码格式，会返回参数错误。
body	设备认证信息。JSON数据格式。具体信息，请参见下表表 2。

表 2. body参数
字段名称	是否必需	说明
productKey	是	设备所属产品的ProductKey。可从物联网平台控制台对应实例下的设备详情页获取。
deviceName	是	设备名称。可从物联网平台控制台对应实例下的设备详情页获取。
clientId	是	客户端ID。长度为64字符内，建议以MAC地址或SN码作为clientId。
timestamp	否	时间戳。校验时间戳15分钟内的请求有效。时间戳格式为数值，值为自GMT 1970年1月1日0时0分到当前时间点所经过的毫秒数。
sign	是	签名。签名计算格式为`hmacmd5(DeviceSecret,content)`。其中，content为将所有提交给服务器的参数（除version、sign和signmethod外），按照英文字母升序，依次拼接排序（无拼接符号）的结果。签名示例：假设clientId = 127.0.0.1，deviceName = http_test，productKey = a1FHTWxQ**，timestamp = 1567003778853，signmethod = hmacmd5，deviceSecret = 89VTJylyMRFuy2T3sywQGbm5Hmk1，签名计算为： `hmacmd5("89VTJylyMRFuy2T3sywQGbm5Hmk1","clientId127.0.0.1deviceNamehttp_testproductKeya1FHTWxQ**timestamp1567003778853").toHexString();` 其中，`toHexString()`是将计算结果二进制数据的每个byte按4 bit转化为十六进制字符串，大小写不敏感。例如，计算结果byte数组是：[60 68 -67 -7 -17 99 30 69 117 -54 -58 -58 103 -23 113 71]，转换后得到的字符串为：3C44BDF9EF631E4575CAC6C667E97147。
signmethod	否	算法类型，支持hmacmd5和hmacsha1。若不传入此参数，则默认为hmacmd5。
version	否	版本号。若不传入此参数，则默认default。

设备认证返回结果示例：

body:
{
  "code": 0,
  "message": "success",
  "info": {
    "token":  "6944e5bfb92e4d4ea3918d1eda39****"
  }
}

说明

请将返回的token值缓存到本地。
每次上报数据时，都需要携带token信息。如果token失效，需要重新认证设备获取token。

表 3. 错误码说明
code	message	备注
10000	common error	未知错误。
10001	param error	请求的参数异常。
20000	auth check error	设备鉴权失败。
20004	update session error	更新失败。
40000	request too many	请求次数过多，流控限制。

上报数据。

设备发送数据到某个Topic，只支持发布权限的Topic，支持自定义Topic。

例如：Topic为/${YourProductKey}/${YourDeviceName}/pub，假设当前设备名称为device123，产品的ProductKey为a1GFjLP****，那么您可以调用 https://iot-as-http.cn-shanghai.aliyuncs.com/topic/a1GFjLP****/device123/pub地址来上报数据。

上报数据请求：

POST /topic/${topic} HTTP/1.1
Host: ${YourEndpoint}
password:${token}
Content-Type: application/octet-stream
body: ${your_data}

表 4. 上报数据参数说明
参数	说明
Method	请求方法，只支持POST方法。
URL	`/topic/${topic}`。其中，变量`${topic}`需替换为数据发往的目标Topic。只支持HTTPS。
Host	Endpoint地址。
password	放在Header中的参数，取值为调用设备认证接口auth返回的token值。
Content-Type	设备发送给物联网平台的上行数据的编码格式，目前仅支持application/octet-stream。若使用其他编码格式，会返回参数错误。
body	发往${topic}的数据内容。

返回结果示例：

body:
{
  "code": 0,
  "message": "success",
  "info": {
    "messageId": 892687627916247040,
  }
}

表 5. 错误码说明
code	message	备注
10000	common error	未知错误。
10001	param error	请求的参数异常。
20001	token is expired	token失效。需重新调用auth进行鉴权，获取token。
20002	token is null	请求header中无token信息。
20003	check token error	根据token获取identify信息失败。需重新调用auth进行鉴权，获取token。
30001	publish message error	数据上行失败。
40000	request too many	请求次数过多，流控限制。