接入指引

概述

IOT-FAST开放平台(IotOs Open Platform)是基于IOT-FAST云平台的开放服务平台。
第三方系统接入IOT-FAST开放平台后,可以获取产品、设备、功能定义等接口能力,快速集成IOT-FAST云平台的设备服务能力。
目前IOT-FAST开放平台仅支持后台服务器(server类型)应用系统接入,平台颁发的appkey和app密钥请妥善保存,防止直接暴露到前端。

创建appkey和app密钥

进入功能界面

打开菜单“系统设置”->“开放平台”,点“新增”。 image.png
填写名称后,点击“确定”,完成创建。 image.png
image.png

调用规则

调用接口时请传入,appkey、sign、timestamp这三个额外共有参数,可直接跟下URL的?号后面使用普通参数传入;也可以放入header中,用header参数传入。

客户端计算数字签名sign的值

计算方法:sign=md5(app密钥#timestamp),例如:
app密钥=a2dcdldjsldg33u9oukler4
timestamp=1614577590133
sign=md5(a2dcdldjsldg33u9oukler4#1614577590133)=bf87cc9d09b0ea2c5a1c73401cf333db

客户端提交参数给服务器

对于method为GET的接口

将sign,timestamp,appkey三个参数连同业务参数一起提交给服务器,例如:
其中typeId,size均为业务参数,服务器对比当前的时间戳和客户端请求中的timestamp,相差若大于30分钟则返回失败。
http://miot.gkiiot.com:8080/openapi/sign/dev/upload/listappkey=xxx&sign=xxxxx&timestamp=123&typeId=1&size=2

对于method为POST的接口

将sign,timestamp,appkey三个参数放在URL中,例如:
业务参数放在请求Body中,根据接口文档指明的form-data或application/json方式调用,将请求发送至服务器,服务器对比当前的时间戳和客户端请求中的timestamp,相差若大于30分钟则返回失败。 部分接口需将id放在请求URL中,具体请参照接口文档。
url参数
http://miot.gkiiot.com:8080/openapi/sign/dev/upload/list?appkey=xxx&sign=xxxxx&timestamp=123
post body
{
“typeId”: 1,
“size”: 2
}

放入header中

除了上面的两种方法外,还可以将参数放入header中进行传参,具体入下图:
image.png