二、Http协议接入Restful API 方式开发指导

1、简介

本章节适用对象为设备侧，供设备采用HTTP协议以Http Restful API方式接入本IOT中继平台使用。

此设备采用http协议接入本IOT中继系统平台，所有接口均使用POST方式访问。主要实现从接入设备上报物模型属性、事件数据。

2、基本术语

• 接口服务器地址（SERVER_URL）：接口的Http资源入口，通常为WebURL。

• 接口名称（INTERFACE）：特定功能的资源访问路径。

• 接口访问令牌（token）：接口调用时用于身份验证的内容,token为登录以后返回的登录信息，每次调用新的接口都需要使用登录后的token。

3、接口调用方式

POST方式调用:(SERVER_URL)/(INTERFACE)

4、接口响应

接口响应内容为JSON格式报文:

响应代码:

5、接入配置信息

服务器地址： http://192.168.0.105:18080

用户名： 134xxxxxxxx  IOT设备接入设置的连接账号 （此设备采用http协议接入，在IOT设备接入配置中设置的设备连接账号）

密码： XXXXXX IOT设备接入设置的连接口令 （此设备采用http协议接入，在IOT设备接入配置中设置的设备连接口令）

Authorization： Bearer xxxxxxxxx （xxxxxxxxx 为登陆鉴权成功返回的token）

特别说明： 此处服务器IP地址为本IOT中继宝盒里面配置的盒子的IP地址，本文档后面出现的IP地址“192.168.0.105 ” 根据您盒子的配置统一替换，在本文档中只是演示使用。

6、登录获取token

Request URL: http://192.168.0.105:18080/oauth/token

Request Method: POST

数据提交格式  application/json

请求头  无

请求体格式 ：

{ "username": "134xxxxxxxx", "password": "******"  }

请求体参数说明：

正确响应结果示例：

{
  "code": "200",
  "msg": "success",
  "data": {
  "token" : "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiNjE3OGVlN2ZhNWM0OWU2ODlmMGEzNjIxNzkxYzk2OCIsInN1YiI6IntcInVzZXJJZFwiOlwiNDlcIixcInVzZXJOYW1lXCI6XCIxMzQzNzE1NjU2OVwiLFwibmlja05hbWVcIjpcIjQ0MDgwMDAwMDAxMTExMDAwMDE3XCJ9IiwiaXNzIjoic2oiLCJpYXQiOjE2OTcxNTk2NjgsImV4cCI6MTY5NzE2MTQ2OH0.4C3GJIF5ejmySHy9l_LmheoCs5jknq17h9tPsZB3dIM",
  }
}

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:用户登录验证失败"
}

7、注销登录

Request URL: http://192.168.0.105:18080/loginOut

Request Method: GET

请求头参数  Authorization

请求头参数说明：

请求体格式 ：无

正确响应结果示例：

{
"msg": "注销成功",
"code": "200",
"data": "{ }"
}

错误响应结果示例：

{
"code": "-1",
"msg": "注销失败"
}

8、上报属性数据

本文档适用对象为设备侧，供设备接入本IOT中继平台使用。 此设备采用http协议接入本IOT中继系统平台，主要实现从接入设备上报物模型属性数据。 设备侧根据业务需要周期性调用此接口向平台上报设备属性数据，例如：间隔10分钟上报设备温度。

Request URL: http://192.168.0.105:18080/httpService/uploadPropertiesData

Request Method: POST

数据提交格式  application/json

请求头参数  Authorization

请求头参数说明：

请求体格式 Content-Type

{
   "deviceId": "44080000001111000017",
   "propertiesList": [
       { "propertiesId": "P_1696583483495", "dataValue": "36" },
       { "propertiesId": "P_1696583483496", "dataValue": "45" },
        。。。。。。
      ]
}

请求体参数说明：

正确响应结果示例：

{
  "code": "0",
  "msg": "success",
  "data": "true",
}

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:数据上报失败"
}

9、上报事件数据

本文档适用对象为设备侧，供设备接入本IOT中继平台使用。 此设备采用http协议接入本IOT中继系统平台，主要实现从接入设备上报物模型事件数据。 设备侧根据业务需要周期性调用此接口向平台上报设备事件数据，例如：设备温度超标关机。

Request URL: http://192.168.0.105:18080/httpService/uploadEventData

Request Method: POST

数据提交格式  application/json

请求头参数  Authorization

请求头参数说明：

请求体格式 Content-Type

{
   "deviceId": "44080000001111000017",
   "eventId": "E_1696584389929",
   "paramsList": [
       { "paramsId": "aaaaa", "dataValue": "36" },
       { "paramsId": "bbbbb", "dataValue": "45" },
        。。。。。。
      ]
 }

请求体参数说明：

正确响应结果示例：

{
  "code": "0",
  "msg": "success",
  "data": "true"
}

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:数据上报失败"
}