主题规范

认证方式

MQTT 无需认证。请求时携带生成的 AppKey 即可。具体使用详见下面各个接口。

主题规范

请求主题

• 格式： /openapi/data/request/{appKey}
• 示例： /openapi/data/request/ABC123456

第三方向此主题发布请求消息，平台会收到请求。

响应主题

• 格式： /openapi/data/response/{appKey}
• 示例： /openapi/data/response/ABC123456

服务端向此主题发布响应消息，第三方需订阅此主题接收响应。

定时推送主题

• 格式： /openapi/data/scheduled/{appKey}
• 示例： /openapi/data/scheduled/ABC123456

服务端定时推送数据（设备状态、实时数据等）时使用此主题。

订阅主题说明

请求主题为第三方向平台调用，无需订阅。但是响应主题和定时推送主题是平台向第三方发布消息，第三方需要订阅这 2 个主题才能接收到消息。

第三方需要订阅的主题：

主题	说明
/openapi/data/response/{appKey}	响应主题
/openapi/data/scheduled/{appKey}	定时推送主题

注意

不能使用通配符进行订阅，使用通配符订阅会提示无法订阅。

消息格式

请求消息格式

{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "queryRegions",
  "data": {
    // 请求参数，根据不同方法而定
  }
}

参数说明：

参数	数据类型	必填	描述
messageId	String	是	消息唯一标识，用于关联请求和响应。响应时会携带此消息 ID，建议使用 UUID
appKey	String	是	AppKey
method	String	是	调用的方法名
data	Object	否	请求参数，根据不同方法而定

响应消息格式

成功响应：

{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "queryRegions",
  "data": {
    "code": 200,
    "message": "success",
    "data": [
      // 业务数据
    ]
  }
}

错误响应：

{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "queryRegions",
  "data": {
    "code": 500,
    "message": "AppKey 不存在",
    "data": null
  }
}

参数说明：

参数	数据类型	描述
messageId	String	与请求消息的 messageId 对应
appKey	String	AppKey
method	String	调用的方法名
data	Object	响应数据
data.code	Integer	响应码：200-成功，500-失败
data.message	String	响应消息
data.data	Object	业务数据，成功时返回实际数据，失败时为 null