1. 下行分发服务

API列表

编号	API名称	路径	版本	动作
1.1	应用网关连接	/inner/connector/session/gateway/connect	1.0	连接注册
1.2	更新网关心跳	/inner/connector/session/gateway/updateHeartbeat	1.0	更新心跳
1.3	服务注册	/inner/connector/session/service/register	1.0	服务注册
1.4	应用网关注销	/inner/connector/session/disconnect	1.0	应用网关断开连接
1.5	应用网关阻断	/inner/connector/session/block	1.0	管理后台禁用应用网关或到期
1.6	查询会话信息	/inner/connector/session/get	1.0	查询应用网关会话信息
1.7	获取agent转发配置	/inner/connector/session/query/{projectId}/product/{templateId}/router	1.0	获取agent通道信息
1.8	获取车场转发配置	/inner/connector/session/query/{projectId}/parking/{parkingLotId}/router	1.0	获取车场agent通道信息
1.9	获取边缘配置中心转发配置	/query/{projectId}/running/center/router	1.0	获取配置中心通道信息

API调用

1.1: 应用网关连接

描述应用网关连接后主动

请求信息

HTTP协议：HTTP,HTTPS

uri：/inner/connector/session/gateway/connect

方法：POST

请求参数

名称	位置	类型	必填	描述
connectorId	body	String	y	从接入层带上来的session信息
channelId	body	String	y	从接入层带上来的会话channel信息
clientId	body	String	y	从接入层带上来的会话clientId信息
appKey	body	String	y	从接入层带上来的会话appKey信息
projectId	body	String	y	从接入层带上来的会话projectId信息
timestamp	body	long	y	时间戳

请求Body描述(Form表单)

{
  "connectorId": "iot-gateway-acceptor_172.16.1.200_1883",
  "channelId": "d5d241ff",
  "clientId": "DEF1D5D2-C4E5-498A-BB81-94441CD9032A",
  "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
  "projectId": "Q0ExQTNCRjc5R",
  "timestamp": 123123123123
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识：200成功，其它参考ResponseCode常量
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
    "code": 200,
    "data": {},
    "message": "success"
}

1.2: 更新接入层心跳

描述：更新心跳

请求信息

HTTP协议：HTTP,HTTPS

uri：/inner/connector/session/gateway/updateHeartbeat

方法：POST

请求参数

名称	位置	类型	必填	描述
connectorId	body	String	y	从接入层带上来的session信息
channelId	body	String	y	从接入层带上来的会话channel信息
clientId	body	String	y	从接入层带上来的会话clientId信息
sessionId	body	String	y	会话记录ID
timestamp	body	long	y	时间戳

请求Body描述(Form表单)

{
  "connectorId": "iot-gateway-acceptor_172.16.1.200_1883",
  "channelId": "d5d241ff",
  "clientId": "DEF1D5D2-C4E5-498A-BB81-94441CD9032A",
  "sessionId": "1deaf2ganvcmiad",
  "timestamp": 123123123123
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识：200成功，其它参考ResponseCode常量
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
    "code": 200,
    "data": {},
    "message": "success"
}

1.3: 边缘agent下行透传（同步）

描述：异步下发设备控制指令

请求信息

HTTP协议：HTTP,HTTPS

uri：/inner/connector/session/service/register

方法：POST

请求参数

名称	位置	类型	必填	描述
session	body	object	y	从接入层带上来的session信息
connectorId	session	String	y	从接入层带上来的session信息
channelId	session	String	y	从接入层带上来的会话channel信息
clientId	session	String	y	从接入层带上来的会话clientId信息
appKey	session	String	y	从接入层带上来的会话appKey信息
projectId	session	String	y	从接入层带上来的会话projectId信息
sessionId	session	String	y	从接入层带上来的会话sessionId信息
payload	body	object	y	下发的payload信息
requestId	payload	String	y	请求ID
data	payload	object	y	上报的payload
type	data	String	y	服务类型: gateway(应用网关), agent（边缘Agent）, service（普通服务）, running-service（运营服务）
serviceName	data	String	y	服务名称项目+应用网关服务名称
serviceId	data	String	y	边缘服务的实例ID
serviceVersion	data	String	y	边缘服务的实例版本: v1.0.0
serviceVersionId	data	String	y	边缘服务的版本ID
templateId	data	String	y	设备模板ID，当type=agent时，模板ID必填
templateCategory	data	String	y	设备模板分类： smart-access（门禁） ,smart-lift（梯控）, smart-lighting（照明）, smart-smart-parking-lot（车场）
parkingLots	data	Array	y	如果templateCategory = smart-smart-parking-lot ,则必传

请求Body描述(Form表单)

{
   "session": {
          "connectorId": "iot-gateway-acceptor_172.16.1.200_1883",
           "channeId": "d5d241ff",
           "clientId": "DEF1D5D2-C4E5-498A-BB81-94441CD9032A",
           "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
           "projectId": "Q0ExQTNCRjc5R",
           "sessionId": "5ddf746dcca2e342c8584e35"
   },
  "topic": "/gateway/adad131231123/service/instance/register",
   "payload": {
         "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
          "data":{
            "serviceName": "领贤公馆-捷顺车场01",
            "type": "agent",
            "serviceId": "jieshun_parkinglot_agent_v1.0.0.0_127.0.0.1_80800",
            "serviceVersion": "v1.0.0",
            "serviceVersionId": "dko0da1",
            "templateId": "d479a9cfaa1434g1314bda14f3d092",
            "templateCategory": "smart-smart-parking-lot",
            "parkingLots": ["12313","123123"]
          },
           "timestamp": 123123123123
    }

}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识：200成功，其它参考ResponseCode常量
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
    "code": 200,
    "data": {},
    "message": "success"
}

1.4: 网关断开连接

描述：网关断开连接

请求信息

HTTP协议：HTTP,HTTPS

uri：/inner/connector/session/disconnect

方法：POST

请求参数

名称	位置	类型	必填	描述
session	body	object	y	从接入层带上来的session信息
connectorId	session	String	y	从接入层带上来的session信息
channelId	session	String	y	从接入层带上来的会话channel信息
clientId	session	String	y	从接入层带上来的会话clientId信息
appKey	session	String	y	从接入层带上来的会话appKey信息
projectId	session	String	y	从接入层带上来的会话projectId信息
sessionId	session	String	y	从接入层带上来的会话sessionId信息

请求Body描述(Form表单)

{
   "session": {
      "connectorId": "iot-gateway-acceptor_172.16.1.200_1883",
      "channelId": "d5d241ff",
      "clientId": "DEF1D5D2-C4E5-498A-BB81-94441CD9032A",
      "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
      "projectId": "Q0ExQTNCRjc5R",
      "sessionId": "5ddf746dcca2e342c8584e35"
   }
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识：200成功，其它参考ResponseCode常量
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
    "code": 200,
    "data": {},
    "message": "success"
}

1.5: 会话阻断

描述：会话阻断

请求信息

HTTP协议：HTTP,HTTPS

uri：/inner/connector/session/block

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	String	y	项目ID
appKey	body	String	y	授权的 key

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123,
   "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
   "projectId": "Q0ExQTNCRjc5R"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识：200成功，其它参考ResponseCode常量
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
    "requestId": "123",
    "code": 200,
    "data": {},
    "message": "success"
}

1.6: 查询最新会话实例

描述：同步下发配置数据

请求信息

HTTP协议：HTTP,HTTPS

uri：/inner/connector/session/get

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	String	y	项目ID
appKey	body	String	y	授权的 key

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123,
   "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
   "projectId": "Q0ExQTNCRjc5R"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识：200成功，其它参考ResponseCode常量
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
    "code": 200,
    "data": {
        "connectorId": "iot-gateway-acceptor_172.16.1.200_1883",
        "channelId": "d5d241ff",
        "clientId": "DEF1D5D2-C4E5-498A-BB81-94441CD9032A",
        "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
        "projectId": "Q0ExQTNCRjc5R",
        "sessionId": "5ddf746dcca2e342c8584e35"
    },
    "message": "success"
}

1.7: 获取agent透传路由

描述：控制agent

请求信息

HTTP协议：HTTP,HTTPS

uri：/inner/connector/session/query/{projectId}/product/{templateId}/router

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	uri	String	y	项目ID
templateId	uri	String	y	设备模板ID
requestId	body	String	y	请求ID
timestamp	body	long	y	时间戳

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识：200成功，其它参考ResponseCode常量
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
connectorId	data	String	是	接入层topic/实例ID
clientId	data	String	是	IOTbox clientID
appKey	data	String	是	授权的key
projectId	data	String	是	项目ID
channelId	data	String	是	接入层长连接ID
serviceId	data	String	是	边缘服务实例ID

返回结果示例

{
    "code": 200,
    "data": {
       "connectorId": "iot-gateway-acceptor_172.16.1.200_1883",
       "clientId": "DEF1D5D2-C4E5-498A-BB81-94441CD9032A",
       "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
       "projectId": "Q0ExQTNCRjc5R",
       "channelId": "d5d241ff",
       "serviceId": "ajhua-door-agent_10.73.162.21_8090" 
    },
    "message": "success"
}

1.8: 获取车场透传路由

描述：控制agent

请求信息

HTTP协议：HTTP,HTTPS

uri：/inner/connector/session/query/{projectId}/parking/{parkingLotId}/router

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	uri	String	y	项目ID
parkingLotId	uri	String	y	车场ID
requestId	body	String	y	请求ID
timestamp	body	long	y	时间戳

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识：200成功，其它参考ResponseCode常量
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
connectorId	data	String	是	接入层topic/实例ID
clientId	data	String	是	IOTbox clientID
appKey	data	String	是	授权的key
projectId	data	String	是	项目ID
channelId	data	String	是	接入层长连接ID
serviceId	data	String	是	边缘服务实例ID

返回结果示例

{
    "code": 200,
    "data": {
       "connectorId": "iot-gateway-acceptor_172.16.1.200_1883",
       "clientId": "DEF1D5D2-C4E5-498A-BB81-94441CD9032A",
       "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
       "projectId": "Q0ExQTNCRjc5R",
       "channelId": "d5d241ff",
       "serviceId": "ajhua-door-agent_10.73.162.21_8090" 
    },
    "message": "success"
}

1.9: 获取项目配置数据透传路由

描述：控制agent

请求信息

HTTP协议：HTTP,HTTPS

uri：/query/{projectId}/running/center/router

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	uri	String	y	项目ID
requestId	body	String	y	请求ID
timestamp	body	long	y	时间戳

请求Body描述(Form表单)

{
   "requestId": "d479a9cfaa7af92b5d694bda14f3d092",
   "timestamp": 13123123123
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识：200成功，其它参考ResponseCode常量
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
connectorId	data	String	是	接入层topic/实例ID
clientId	data	String	是	IOTbox clientID
appKey	data	String	是	授权的key
projectId	data	String	是	项目ID
channelId	data	String	是	接入层长连接ID
serviceId	data	String	是	边缘服务实例ID

返回结果示例

{
    "code": 200,
    "data": {
       "connectorId": "iot-gateway-acceptor_172.16.1.200_1883",
       "clientId": "DEF1D5D2-C4E5-498A-BB81-94441CD9032A",
       "appKey": "0RFMTExNzUzMzg3QUU1MUJGQzk",
       "projectId": "Q0ExQTNCRjc5R",
       "channelId": "d5d241ff",
       "serviceId": "ajhua-door-agent_10.73.162.21_8090" 
    },
    "message": "success"
}

1. 下行分发服务

API列表

API调用

1.1: 应用网关连接

描述 应用网关连接后主动

请求信息

请求参数

请求Body描述(Form表单)

返回信息

返回参数类型

返回参数

返回结果示例

1.2: 更新接入层心跳

描述：更新心跳

请求信息

请求参数

请求Body描述(Form表单)

返回信息

返回参数类型

返回参数

返回结果示例

1.3: 边缘agent下行透传（同步）

描述： 异步下发设备控制指令

请求信息

请求参数

请求Body描述(Form表单)

返回信息

返回参数类型

返回参数

返回结果示例

1.4: 网关断开连接

描述： 网关断开连接

请求信息

请求参数

请求Body描述(Form表单)

返回信息

返回参数类型

返回参数

返回结果示例

1.5: 会话阻断

描述： 会话阻断

请求信息

请求参数

请求Body描述(Form表单)

返回信息

返回参数类型

返回参数

返回结果示例

1.6: 查询最新会话实例

描述： 同步下发配置数据

请求信息

请求参数

请求Body描述(Form表单)

返回信息

返回参数类型

返回参数

返回结果示例

1.7: 获取agent透传路由

描述： 控制agent

请求信息

请求参数

请求Body描述(Form表单)

返回信息

返回参数类型

返回参数

返回结果示例

1.8: 获取车场透传路由

描述： 控制agent

请求信息

请求参数

请求Body描述(Form表单)

返回信息

返回参数类型

返回参数

返回结果示例

1.9: 获取项目配置数据透传路由

描述： 控制agent

请求信息

请求参数

请求Body描述(Form表单)

描述应用网关连接后主动

描述：异步下发设备控制指令

描述：网关断开连接

描述：会话阻断

描述：同步下发配置数据

描述：控制agent

描述：控制agent

描述：控制agent