API列表

endpoint: https://api-aep.xiot.senthink.com path: 参考接口描述中的请求地址说明

api列表中接口调用必须携带公共请求头，公共请求头如下。

Headers：

产品管理

添加产品

接口名称： 添加产品

接口描述： 添加产品

请求地址： /api/senthink/aep/openApi/product/v1/add

传参方式：POST

备注： 无

请求参数

Headers：

Body:

响应参数

data 说明如下

请求示例

直连设备示例
{
  "name": "api添加产品测试",
  "accessType": 1,
  "netType":1,
  "protocol": 1,
  "deviceType": 0,
  "securityType": 0,
  "authType": 0,
  "payloadFormat": 0,
  "encrypted":0
}

云云对接产品添加示例
{
  "accessType": 2,
  "ctwingAppId": 66675,
  "ctwingAppKey": "DPtXJK2CZrc",
  "ctwingAppSecret": "vLqJk5H5w7",
  "ctwingMasterKey": "d8ad99856eab4f46822d704b5bb2b2ea",
  "ctwingProductId": 15074825,
  "dataFormat": 0,
  "deviceType": 0,
  "name": "openapi云云对接产品",
  "netType": 1,
  "payloadFormat": 0,
  "productDesc": "这是产品信息",
  "ctwingPayloadFormat":"1",
  "productId": "",
  "protocol": 1
}

子设备产品添加示例
{
    "accessType": 3,
    "deviceType": 0,
    "protocol": 1,
    "encrypted": 0,
    "netType": 4,
    "securityType": 1,
    "name": "api添加子设备产品1",
    "authType": 0,
    "payloadFormat": "1",
    "productDesc": "产品描述",
    "dataFormat": 1,
    "gatewayProtocol": "0"
}

响应示例

直连设备：
{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "productId": "30DE513B",
    "productKey": "7313D093201946494C1C81E3E93B5D11",
    "id": "601e83a9ffc81f7739951e82",
    "name": "api添加产品测试7",
    "accessType": "设备直连",
    "netType": "移动蜂窝数据",
    "protocol": "MQTT",
    "deviceType": "设备",
    "securityType": "一型一密免注册",
    "authType": "AES128",
    "payloadFormat": "透传",
    "encrypted": "不加密",
    "productDesc": null,
    "createAt": "2021-02-06 21:43:48"
  }
}
云云对接产品：
{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "productId": "A570A443",
    "productKey": "B1D1EBB81260CA9A9C1A07A04D8CBA9B",
    "id": "617f98be90a57f1fdff43039",
    "name": "openapi云云对接产品1",
    "accessType": "云云对接",
    "netType": "移动蜂窝数据",
    "protocol": "MQTT",
    "deviceType": "设备",
    "securityType": null,
    "authType": null,
    "payloadFormat": "透传",
    "encrypted": "不加密",
    "productDesc": "这是产品信息",
    "createAt": "2021-11-01 15:35:26"
  }
}

子设备产品：
{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "productId": "298DAB80",
        "productKey": "200A7F9FEA848DDD10936E857206A494",
        "id": "61ea56d8fc66163ed7f19888",
        "name": "api添加子设备产品1",
        "accessType": "网关接入",
        "netType": "NB-IOT",
        "protocol": "MQTT",
        "deviceType": "设备",
        "securityType": null,
        "authType": null,
        "payloadFormat": "非透传",
        "encrypted": "不加密",
        "productDesc": "产品描述",
        "createAt": "2022-01-21 14:46:47"
    }
}

错误码

删除产品

接口名称： 删除产品

接口描述： 删除产品

请求地址： /api/senthink/aep/openApi/product/v1/delete 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

请求示例

{
  "id": "601ba1affc73a85454cdae21"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

错误码

编辑产品

接口名称： 编辑产品

接口描述： 编辑产品

请求地址： /api/senthink/aep/openApi/product/v1/edit

传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

请求示例

{
  "id": "617f601fc496415b0adfa0fe",
  "name": "智能钓鱼竿子",
  "productDesc": "崭新的描述，后台测试产品"
}

响应示例

{
"code":"8001",
"msg":"操作成功",
"data":true
}

错误码

产品列表

接口名称： 产品列表

接口描述： 列表产品

请求地址： /api/senthink/aep/openApi/product/v1/list

传参方式：POST

备注： 无

请求参数

Headers：

Body:

无

返回数据

data中的每个产品的数据结构是：

请求示例

{}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "data": {
      "records": [
        {
          "id": "5fe4468d889d320e238d447b",
          "name": "后端调试用-tcp-免注册",
          "productId": "C1168332",
          "protocol": 0,
          "deviceNum": 0,
          "deviceType": 0,
          "createAt": "2020-12-24 15:43:09"
        },
        {
          "id": "5fe4468d889d320e238d447e",
          "name": "后端调试用-mqtt-免注册",
          "productId": "9ACB2DCC",
          "protocol": 0,
          "deviceNum": 1,
          "deviceType": 0,
          "createAt": "2020-12-24 15:43:09"
        },
      ],
      "pages": 2,
      "current": 1,
      "size": 10,
      "searchCount": true,
      "total": 2,
      "optimizeCount": true,
      "offset": 0,
      "limit": 2147483647,
      "asc": true,
      "orderByField": null
    },
    "nodeTypeEnum": {
      "0": "设备",
      "1": "网关"
    },
    "protocolEnum": {
      "0": "TCP",
      "1": "MQTT"
    }
  }
}

查询产品

接口名称： 查询产品

接口描述： 查询产品

请求地址： /api/senthink/aep/openApi/product/v1/query

传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

data的数据结构与产品列表接口的列表元素一致：

请求示例:

{
  "id": "601ba1affc73a85454cdae21"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "id": "601ba1affc73a85454cdae21",
    "name": "智能电动车",
    "accessType": 1,
    "netType": 1,
    "protocol": 1,
    "deviceType": 0,
    "securityType": 0,
    "authType": 0,
    "payloadFormat": 0,
    "encrypted": 0,
    "productDesc": null,
    "productId": "AB90E2E0"
    "topic": null
  }
}

mqtt 产品详情如下

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "productId": "30DE513B",
    "productKey": "7313D093201946494C1C81E3E93B5D11",
    "id": "601e83a9ffc81f7739951e82",
    "name": "api添加产品测试7",
    "accessType": "设备直连",
    "netType": "移动蜂窝数据",
    "protocol": "MQTT",
    "deviceType": "设备",
    "securityType": "一型一密免注册",
    "authType": "AES128",
    "payloadFormat": "透传",
    "encrypted": "不加密",
    "productDesc": null,
    "createAt": null,
    "topic": [
      {
        "function": "认证",
        "topic": "/sys/device/auth",
        "permission": 0,
        "desc": "用于设备认证"
      },
      {
        "function": "入网",
        "topic": "/sys/device/join",
        "permission": 0,
        "desc": "用于设备入网"
      },
      {
        "function": "心跳",
        "topic": "/sys/EEF63A10/30DE513B/${deviceId}/heartbeat",
        "permission": 0,
        "desc": "用于心跳上报"
      },
      {
        "function": "上报",
        "topic": "/sys/EEF63A10/30DE513B/${deviceId}/uplink",
        "permission": 0,
        "desc": "用于数据上报"
      },
      {
        "function": "下行",
        "topic": "/sys/EEF63A10/30DE513B/${deviceId}/downlink",
        "permission": 1,
        "desc": "接收下行指令"
      }
    ],
    "deviceCnt": 0
  }
}

错误码

获取产品物模型TSL

接口名称：获取产品物模型TSL

接口描述：暂无

请求地址：/api/senthink/aep/openApi/product/v1/getTsl

传参方式：POST

备注：暂无

请求参数

Headers：

Body：

返回数据

请求示例

{
    "id":"7F375F1C"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": "{\"profile\":{\"version\":\"1.0\",\"productKey\":\"91EDBA9A376ACB1CFA04791B3B0701AA\",\"productModelId\":\"61ea248bab40077dc259c4f0\"},\"properties\":[{\"identifier\":\"subNodeStatus\",\"name\":\"子节点状态\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"1\",\"max\":\"2\",\"step\":\"1\",\"unit\":\"stepCount\"}},\"accessMode\":\"r\"},{\"identifier\":\"electricity\",\"name\":\"电量\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"0\",\"max\":\"100\",\"step\":\"1\",\"unit\":\"%\"}},\"accessMode\":\"r\"},{\"identifier\":\"joinStatus\",\"identifierOld\":\"joinStatus\",\"name\":\"从节点入网状态\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"0\",\"max\":\"1\",\"step\":\"1\",\"unit\":\"pcs\"}},\"accessMode\":\"rw\"},{\"identifier\":\"ledStatus\",\"identifierOld\":\"ledStatus\",\"name\":\"led状态\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"0\",\"max\":\"1\",\"step\":\"1\",\"unit\":\"pcs\"}},\"accessMode\":\"rw\"},{\"identifier\":\"command\",\"name\":\"命令字\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"0\",\"max\":\"10000\",\"step\":\"1\",\"unit\":\"pcs\"}},\"accessMode\":\"rw\"},{\"identifier\":\"temperature\",\"identifierOld\":\"temperature\",\"name\":\"从节点温度\",\"dataType\":{\"type\":\"float\",\"spec\":{\"min\":\"-1000.0\",\"max\":\"1000.0\",\"step\":\"1.0\",\"unit\":\"°C\"}},\"accessMode\":\"rw\"},{\"identifier\":\"humidity\",\"name\":\"从节点湿度\",\"dataType\":{\"type\":\"float\",\"spec\":{\"min\":\"-1000.0\",\"max\":\"1000.0\",\"step\":\"1.0\",\"unit\":\"pcs\"}},\"accessMode\":\"rw\"},{\"identifier\":\"channel\",\"name\":\"主节点信道\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"0\",\"max\":\"10000\",\"step\":\"1\",\"unit\":\"pcs\"}},\"accessMode\":\"rw\"},{\"identifier\":\"subNodeId\",\"name\":\"从节点ID\",\"dataType\":{\"type\":\"text\",\"spec\":{\"length\":10240}},\"accessMode\":\"rw\"},{\"identifier\":\"nodeId\",\"name\":\"主节点ID\",\"dataType\":{\"type\":\"text\",\"spec\":{\"length\":10240}},\"accessMode\":\"rw\"}],\"events\":[{\"identifier\":\"test3\",\"name\":\"测试事件3\",\"type\":\"warn\",\"outputData\":[]},{\"identifier\":\"test2\",\"name\":\"测试事件2\",\"type\":\"info\",\"outputData\":[]}],\"services\":[{\"identifier\":\"ledcontrol\",\"identifierOld\":\"ledcontrol\",\"name\":\"led控制\",\"callType\":\"sync\",\"inputData\":[{\"identifier\":\"nodeId\",\"identifierOld\":\"nodeId\",\"name\":\"主节点ID\",\"dataType\":{\"type\":\"text\",\"spec\":{\"length\":10240}}},{\"identifier\":\"subNodeId\",\"identifierOld\":\"subNodeId\",\"name\":\"子节点ID\",\"dataType\":{\"type\":\"text\",\"spec\":{\"length\":10240}}},{\"identifier\":\"command\",\"identifierOld\":\"command\",\"name\":\"命令字\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"0\",\"max\":\"10000\",\"step\":\"1\",\"unit\":\"pcs\"}}},{\"identifier\":\"joinStatus\",\"identifierOld\":\"joinStatus\",\"name\":\"入网状态\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"0\",\"max\":\"1\",\"step\":\"1\",\"unit\":\"pcs\"}}},{\"identifier\":\"ledStatus\",\"identifierOld\":\"ledStatus\",\"name\":\"led状态\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"0\",\"max\":\"1\",\"step\":\"1\",\"unit\":\"pcs\"}}}],\"outputData\":[]}]}"
}

推送应用管理

添加推送应用

接口名称： 添加推送应用

接口描述： 添加推送应用

请求地址： /api/senthink/aep/openApi/pushApp/v1/add

传参方式：POST

备注： 无

请求参数

Headers：

Body:

httpPushInfo的结构：

mqttPushInfo结构：

rabbitmqPushInfo结构：

返回数据

data 说明如下

添加mqtt应用和rabbitmq应用之后，系统会为其生成添加相关信息

mqttPushInfo结构：

rabbitmqPushInfo结构：

请求示例

备注: subProductDocIds 为产品的唯一id，可以通过获取产品列表或者详情，对应id字段

1 http类型推送

{
  "appName": "智能钓鱼竿子推送应用",
  "httpPushInfo": {
    "httpConnectRemote": "localhost:8080/receive/conn",
    "httpHeartBeatRemote": "localhost:8080/receive/heart",
    "httpOtaResultRemote": "localhost:8080/receive/ota",
    "httpUplinkRemote": "localhost:8080/receive/uplink",
    "httpNeedVerify":0
  },
  "pushType": 0,
  "status": 1,
  "subProductDocIds": [
    "5ff59e6350189b67bf49cc08"
  ]
}

响应

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "id": "601f445c1cf43b639837cfe2",
    "appSecret": "2B5248825C0470FA1B6CF9EAAF02F491",
    "status": "启用",
    "appName": "apiHttp智能钓鱼竿子推送应用3",
    "createAt": "2021-02-07 09:37:32",
    "subProductDocIds": [
      "601ba0f9fc73a85454cdae20"
    ],
    "subProductNames": [
      "api添加产品测试"
    ],
    "pushType": "HTTP",
    "httpPushInfo": {
      "httpUplinkRemote": "localhost:8080/receive/uplink",
      "httpHeartBeatRemote": "localhost:8080/receive/heart",
      "httpConnectRemote": "localhost:8080/receive/conn",
      "httpOtaResultRemote": "localhost:8080/receive/ota",
      "httpNeedVerify": 0
    }
  }
}

2 rabbitmq类型推送

{
  "appName": "智能钓鱼竿子推送应用",
  "rabbitMqPushInfo": {
    "rabbitAdmin": "iotTest",
    "rabbitBroker": "106.15.251.107",
    "rabbitExchangePrefix": "any",
    "rabbitPassword": "iotTest",
    "rabbitPort": 5672,
    "rabbitVHost": "xiot"
  },
  "pushType": 2,
  "status": 1,
  "subProductDocIds": [
    "5ff59e6350189b67bf49cc08"
  ]
}

响应

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "id": "601f44a41cf43b639837cfe3",
    "appSecret": "6A02638ABFDC4EE57D15EBE5F1BD2BBC",
    "status": "启用",
    "appName": "apiRabbit智能钓鱼竿子推送应用",
    "createAt": "2021-02-07 09:38:44",
    "subProductDocIds": [
      "601ba0f9fc73a85454cdae20"
    ],
    "subProductNames": [
      "api添加产品测试"
    ],
    "pushType": "RABBITMQ",
    "rabbitMqPushInfo": {
      "rabbitBroker": "106.15.251.107",
      "rabbitPort": 5672,
      "rabbitAdmin": "iotTest",
      "rabbitPassword": "iotTest",
      "rabbitVHost": "xiot",
      "rabbitUplinkExchange": "any-app-data",
      "rabbitConnectExchange": "any-connect",
      "rabbitHeartBeatExchange": "any-heartbeat",
      "rabbitOtaResultExchange": "any-ota-result",
      "rabbitExchangePrefix": "any",
      "pushDataFormat": "JSON"
    }
  }
}

3 mqtt类型推送

{
  "appName": "智能电动车mqtt推送",
  "mqttPushInfo": {
    "mqttAdmin": "admin",
    "mqttBroker": "tcp://106.15.251.107:1883",
    "mqttPassword": "chengw",
    "mqttPort": 1883
  },
  "pushDataFormat": 1,
  "pushType": 1,
  "status": 1,
  "subProductDocIds": [
    "5ff59e6350189b67bf49cc08"
  ]
}

响应

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "id": "601f44dd1cf43b639837cfe4",
    "appSecret": "3FD1F8F6EB3423CA3F10BD9C359414B5",
    "status": "启用",
    "appName": "apiMqtt智能钓鱼竿子推送应dd用",
    "createAt": "2021-02-07 09:39:41",
    "subProductDocIds": [
      "601ba0f9fc73a85454cdae20"
    ],
    "subProductNames": [
      "api添加产品测试"
    ],
    "pushType": "MQTT",
    "mqttPushInfo": {
      "mqttBroker": "tcp://106.15.251.107:1883",
      "mqttPort": 1883,
      "mqttAdmin": "admin",
      "mqttPassword": "chengw",
      "mqttQos": 2,
      "mqttUplinkTopic": "jTKgcDTFENwYHlYGtprM/app-data",
      "mqttConnectTopic": "jTKgcDTFENwYHlYGtprM/connect",
      "mqttHeartBeatTopic": "jTKgcDTFENwYHlYGtprM/heartbeat",
      "mqttOtaResultTopic": "jTKgcDTFENwYHlYGtprM/ota-result",
      "pushDataFormat": "JSON"
    }
  }
}

错误码

删除推送应用

接口名称： 删除推送应用

接口描述： 删除推送应用

请求地址： /api/senthink/aep/openApi/pushApp/v1/delete

传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

请求示例

{
  "id": "601bb356112352169e31a57c"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": "操作成功"
}

错误码

编辑推送应用

接口名称： 编辑推送应用

接口描述： 编辑推送应用

请求地址： /api/senthink/aep/openApi/pushApp/v1/edit

传参方式：POST

备注： 无

请求参数

Headers：

Body:

httpPushInfo的结构：

mqttPushInfo结构：

rabbitmqPushInfo结构：

返回数据

请求示例

编辑http推送应用

{
  "id": "601bbdb339fa955d3accf378",
  "appName": "智能电动自行车http推送",
  "httpPushInfo": {
    "httpConnectRemote": "localhost:8080/receive/conn",
    "httpHeartBeatRemote": "localhost:8080/receive/heart",
    "httpOtaResultRemote": "localhost:8080/receive/ota",
    "httpUplinkRemote": "localhost:8080/receive/uplink",
    "httpNeedVerify":0
  },
  "pushDataFormat": 0,
  "pushType": 0,
  "subProductDocIds": [
    "601ba0f9fc73a85454cdae20"
  ]
}

编辑rabbitmq 推送

请求示例

{
  "id": "601bbd7639fa955d3accf377",
  "appName": "智能电动自行车rabbitmq推送",
  "rabbitMqPushInfo": {
    "rabbitAdmin": "xiotAdmin",
    "rabbitBroker": "localhost",
    "rabbitExchangePrefix": "push-exchange",
    "rabbitPassword": "xiotPassword",
    "rabbitPort": 5672,
    "rabbitVHost": "xiot"
  },
  "pushDataFormat": 1,
  "pushType": 2,
  "status": 1,
  "subProductDocIds": [
    "601ba0f9fc73a85454cdae20"
  ]
}

编辑mqtt #### 请求示例

{
  "id": "601bbd7639fa955d3accf377",
  "appName": "智能电动自行车mqtt推送",
  "rabbitMqPushInfo": {
    "rabbitAdmin": "iotTest",
    "rabbitBroker": "106.15.251.107",
    "rabbitExchangePrefix": "any1",
    "rabbitPassword": "iotTest",
    "rabbitPort": 5672,
    "rabbitVHost": "xiot",
    "rabbitUplinkExchange": "any-app-data",
    "rabbitConnectExchange": "any-connect",
    "rabbitHeartBeatExchange": "any-heartbeat",
    "rabbitOtaResultExchange": "any-ota-result"
  },
  "pushDataFormat": 1,
  "pushType": 2,
  "status": 1,
  "subProductDocIds": [
    "601ba0f9fc73a85454cdae20"
  ]
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": "操作成功"
}

错误码

查询推送应用

接口名称： 查询推送应用 接口描述： 查询推送应用

请求地址： /api/senthink/aep/openApi/pushApp/v1/query 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

data的数据结构如下：

httpPushInfo的结构：

mqttPushInfo结构：

rabbitmqPushInfo结构：

请求示例

{
  "id": "601bbdba39fa955d3accf379"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "id": "601bbdba39fa955d3accf379",
    "appSecret": "04886D03DF99B7CFF9A70C48A0AFD943",
    "companyId": "EEF63A10",
    "status": 1,
    "appName": "智能电动车mqtt推送",
    "createAt": "2021-02-04 17:26:18",
    "subProductDocIds": [
      "601ba0f9fc73a85454cdae20"
    ],
    "subProductNames": [
      "智能电动车"
    ],
    "pushType": 1,
    "pushDataFormat": 1,
    "httpPushInfo": null,
    "mqttPushInfo": {
      "mqttBroker": "tcp://localhost:1883",
      "mqttPort": 1883,
      "mqttAdmin": "admin",
      "mqttPassword": "xxxx",
      "mqttQos": 2,
      "mqttUplinkTopic": "uplink",
      "mqttConnectTopic": "connect",
      "mqttHeartBeatTopic": "heartbeat",
      "mqttOtaResultTopic": "otaResult"
    },
    "rabbitMqPushInfo": null
  }
}

错误码

推送应用分页查询

接口名称： 推送应用分页查询 接口描述： 推送应用分页查询 请求地址： /api/senthink/aep/openApi/pushApp/v1/getByPage 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

data：

PushAppInfo 结构如下

httpPushInfo/mqttPushInfo/rabbitMqPushInfo 参考推送应用详情

设备管理

添加设备

接口名称： 添加设备 接口描述： 添加设备

请求地址： /api/senthink/aep/openApi/nodes/v1/add 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

data 的数据结构如下

请求示例

{
  "deviceName": "智能电动车001",
  "nodeEui": "123456456222010",
  "productDocId": "601ba0f9fc73a85454cdae20"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "id": "61542f256d6429794f3ec4b5",
    "nodeEui": "123456456222012",
    "deviceSecret": "D9A89F2591C52A94D55E685DA2195D90",
    "openID": "3806E26C",
    "productID": "66E6128D",
    "productKey": "FC10402C55B1CA13A69B907128E4DFFD",
    "mqttAccount": {
      "transUsername": "3806E26C-66E6128D-123456456222012",
      "transPassword": "D9A89F2591C52A94D55E685DA2195D90",
      "authUsername": null,
      "authPassword": null
    }
  }
}

错误码

删除设备

接口名称： 查询推送应用 接口描述： 查询推送应用

请求地址： /api/senthink/aep/openApi/nodes/v1/delete 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

请求示例

{
    "nodeEui": "00197"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": "操作成功"
}

错误码

编辑设备

接口名称： 查询推送应用 接口描述： 查询推送应用

请求地址： /api/senthink/aep/openApi/nodes/v1/edit 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

请求示例

{
    "nodeEui": "00196",
    "deviceName": "device_00196"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": "操作成功"
}

错误码

设备分页查询

接口名称： 查询推送应用 接口描述： 查询推送应用

请求地址： /api/senthink/aep/openApi/nodes/v1/getByPage 传参方式：POST

备注： 无

请求参数

Headers：

Query：

Body:

返回数据

data的数据结构为：

NodeInfo结构为：

请求示例

无参示例

备注: 请求参数可以为空，则为不带条件查询，默认分页参数，page=1 , pageSize=10

{}

全参示例

{
  "connectStatus": -1,
  "enableStatus": 1,
  "page": 1,
  "pageSize": 10,
  "productDocId": "601ba0f9fc73a85454cdae20",
  "search": "123456456222010"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "connectEnum": {
      "0": "离线",
      "-1": "未激活",
      "1": "在线"
    },
    "statusEnum": {
      "0": "禁用",
      "1": "启用"
    },
    "data": {
      "records": [
        {
          "id": "603716ef1fe38858926853d8",
          "productId": "11765942",
          "productName": "TCP产品",
          "nodeEui": "1234564562",
          "deviceName": "api添加设备2 ",
          "deviceType": 0,
          "deviceSecret": "0140321977C6E44130F59C6AE0EB9EE0",
          "connected": -1,
          "createAt": "2021-02-25 11:18:07",
          "activeAt": null,
          "lastJoinAt": null,
          "lastHeartbeatAt": null,
          "status": 1
        },
        {
          "id": "603716e31fe38858926853d7",
          "productId": "11765942",
          "productName": "TCP产品",
          "nodeEui": "123456456",
          "deviceName": "api添加设备 ",
          "deviceType": 0,
          "deviceSecret": "29984CE9A60F33CEBED6623885AE4428",
          "connected": -1,
          "createAt": "2021-02-25 11:17:55",
          "activeAt": null,
          "lastJoinAt": null,
          "lastHeartbeatAt": null,
          "status": 1
        }
      ],
      "pages": 1,
      "current": 1,
      "size": 10,
      "total": 2
    },
    "nodeTypeEnum": {
      "0": "设备",
      "1": "网关"
    }
  }
}

设备详情

接口名称： 查询设备详情 接口描述： 查询设备详情

请求地址： /api/senthink/aep/openApi/nodes/v1/query 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

data的格式如下：

请求示例

{
    "nodeEui": "0000005"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "id": "601bd344ae7172378618130c",
    "productDocId": "601ba0f9fc73a85454cdae20",
    "productId": "0C9ACD5E",
    "productKey": "F9D9F610E9AE28267CA265BA74EDF562",
    "nodeEui": "123456456222010",
    "deviceName": "智能电动车001",
    "uniqueId": "9D56DE0D216A4AA38A550900302DEA35",
    "deviceSecret": "EDE39469BFBD5D53B1DDF3A5A952DB9C",
    "companyId": "EEF63A10",
    "connected": -1,
    "activeAt": null,
    "lastJoinAt": null,
    "lastHeartbeatAt": null,
    "lastDisconnectAt": null,
    "status": 1,
    "localLogReport": null,
    "createAt": "2021-02-04 18:58:12",
    "sessionKey": null,
    "productName": "智能电动车",
    "accessType": 1,
    "netType": 1,
    "protocol": 1,
    "deviceType": 0,
    "securityType": 0,
    "encrypted": 0,
    "authType": 0,
    "payloadFormat": 0,
    "topic": [
      {
        "function": "认证",
        "topic": "/sys/device/auth",
        "permission": 0,
        "desc": "用于设备认证"
      },
      {
        "function": "入网",
        "topic": "/sys/device/join",
        "permission": 0,
        "desc": "用于设备入网"
      },
      {
        "function": "心跳",
        "topic": "/sys/EEF63A10/0C9ACD5E/123456456222010/heartbeat",
        "permission": 0,
        "desc": "用于心跳上报"
      },
      {
        "function": "上报",
        "topic": "/sys/EEF63A10/0C9ACD5E/123456456222010/uplink",
        "permission": 0,
        "desc": "用于数据上报"
      },
      {
        "function": "下行",
        "topic": "/sys/EEF63A10/0C9ACD5E/123456456222010/downlink",
        "permission": 1,
        "desc": "接收下行指令"
      }
    ],
    "hardVer": null,
    "softVer": null,
    "versionReportAt": null,
    "otaType": null，
    "mqttAccount": {
      "transUsername": "3806E26C-66E6128D-123456789",
      "transPassword": "1F5E5812FC56076ADC135827E07CE503",
      "authUsername": null,
      "authPassword": null
    }，
    "modeId": null,
    "ctwingProductId": null,
    "ctwingMasterKey": null,
    "ctwingAppId": null,
    "ctwingAppKey": null,
    "ctwingAppSecret": null,
    "online": false
  }
}

错误码

透传命令下发

接口名称： 透传命令下发

接口描述： 仅支持透传（包括普通的透传和自定义Topic透传命令下发），物模型的属性设置、属性查询、服务调用都不走该接口逻辑。

请求地址： /api/senthink/aep/openApi/nodes/v1/instruct

传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

请求示例

{
  "nodeEui": "1000001",
  "instruction": "FFFF",
  "instructionType": 0,
  "debugType": 0
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": "操作成功"
}

错误码

属性设置

接口名称： 属性设置 接口描述： 当产品为物模型产品时，下发指令设置产品属性，调用前提，产品已定义物模型，且设置的属性为可写可读属性

请求地址： /api/senthink/aep/openApi/model/v1/propertySet 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

请求示例

{
    "nodeEui": "00196",
    "identify": "humidity",
    "value": "44"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

错误码

属性查询

接口名称： 属性设置 接口描述： 当产品为物模型产品时，下发指令查询产品属性，调用前提，产品已定义物模型，且查询的属性已定义

请求地址： /api/senthink/aep/openApi/model/v1/propertyAsk 传参方式：POST

备注： 设备收到平台下发属性查询指令后应该通过属性上报属性

请求参数

Headers：

Body:

返回数据

请求示例

{
  "nodeEui": "00196",
  "identify": "humidity"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

错误码

服务调用

接口名称： 服务调用 接口描述： 当产品为物模型产品时，可以通过服务调用来进行指令下发，服务调用分为同步调用和异步条用，其返回结果相应不同，异步结果立即返回，同步调用其结果会在10s内返回，如果10s后才返回结果，则返回结果和异步调用结果一致，调用前提，产品已定义物模型，并且调用的服务标识和参数和定义的一致

请求地址： /api/senthink/aep/openApi/model/v1/serviceCall

传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

请求示例

{
  "nodeEui": "00196",
  "identify": "sum",
  "value": "{"a":28,"b": 28}"
}

响应示例

同步结果：
{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

异步结果：
{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "outputData": {
            "Result": "Success"
        },
        "messageId": 1251017933
    }
}

错误码

自定义Topic下发(透传)

接口名称：自定义Topic下发指令

接口描述：也是透传下发，和普通透传下发的区别是该方式使用的是自定义的Topic进行透传

请求地址：/api/senthink/aep/openApi/nodes/v1/custom/instruct

传参方式：POST

备注：要提前定义好Topic才能使用

请求参数

Headers：

Body：

返回数据

请求示例

{
  "nodeEui": "00196",
  "topic": "/sys/sub/520CFD08/B63131F8/00196/custom/lei_test",
  "instruction": "123!"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": "操作成功"
}

批量注册设备

接口名称：批量注册设备

接口描述：无

请求地址：/api/senthink/aep/openApi/nodes/v1/batchAdd

传参方式：POST

备注：无

请求参数

Headers：

Body：

参数nodes结构如下：

返回数据

请求示例

{
  "productId": "4D163A46",
  "nodes": [
    {
      "deviceEui": "M10000004",
      "deviceName": ""
    },
    {
      "deviceEui": "M12",
      "deviceName": ""
    },
    {
      "deviceEui": "",
      "deviceName": ""
    }
  ]
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "successNum": 0,
        "failNum": 3,
        "certificateKey": null,
        "failExcelUrl": null,
        "failReasons": [
            {
                "deviceEui": "",
                "deviceName": "",
                "failReason": "设备编号缺失",
                "code": "4419"
            },
            {
                "deviceEui": "M12",
                "deviceName": "",
                "failReason": "deviceEui格式非法",
                "code": "4400"
            },
            {
                "deviceEui": "M10000004",
                "deviceName": "",
                "failReason": "设备号已存在",
                "code": "4409"
            }
        ]
    }
}

查询设备物模型属性列表

接口名称：查询设备物模型属性列表

接口描述：该接口用于查询物模型设备的物模型属性以及当前的属性值

请求地址：/api/senthink/aep/openApi/model/v1/getPropertyReportList

传参方式：POST

备注：暂无

请求参数

Headers：

Body：

返回数据

请求示例

{
    "nodeEui":"41086873905413635700"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "id": "c67cd258-57bd-45a2-a92c-3511aced3521",
                "time": "2022-05-12T03:34:27.436Z",
                "companyId": null,
                "productId": "910AB0D4",
                "nodeEui": null,
                "identifier": "BatWorkModeCtl",
                "accessMode": "rw",
                "name": "电池工作模式切换",
                "value": "0000"
            }
        ],
        "pages": 1,
        "current": 1,
        "size": 10,
        "searchCount": true,
        "total": 0,
        "optimizeCount": true,
        "offset": 0,
        "limit": 2147483647,
        "asc": true,
        "orderByField": null
    }
}

查询设备单个物模型属性

接口名称：查询设备单个物模型属性

接口描述：用于查询设备某个物模型属性的历史上报记录

请求地址：/api/senthink/aep/openApi/model/v1/getPropertyReportSingleList

传参方式：POST

备注：暂无

请求参数

Headers：

Body：

返回数据

请求示例

{
    "nodeEui":"41086873905413635700",
    "search":"socStandard"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "id": "d83bfc52-5ba1-49e9-810d-54048ca25002",
                "time": "2022-05-12T03:34:27.436Z",
                "companyId": "FFDEA01F",
                "productId": "910AB0D4",
                "nodeEui": "41086873905413635700",
                "identifier": "socStandard",
                "accessMode": "rw",
                "name": "soc低电量阈值",
                "value": "30"
            },
            {
                "id": "cfc8a81b-ba5b-4c92-96ae-a3263bb05071",
                "time": "2022-05-12T03:15:55.715Z",
                "companyId": "FFDEA01F",
                "productId": "910AB0D4",
                "nodeEui": "41086873905413635700",
                "identifier": "socStandard",
                "accessMode": "rw",
                "name": "soc低电量阈值",
                "value": "30"
            }
        ],
        "pages": 1,
        "current": 1,
        "size": 10,
        "searchCount": true,
        "total": 4,
        "optimizeCount": true,
        "offset": 0,
        "limit": 2147483647,
        "asc": true,
        "orderByField": null
    }
}

分页查询服务

接口名称：分页查询服务

接口描述：该接口用于分页查询设备的物模型服务调用历史

请求地址：/api/senthink/aep/openApi/model/v1/getServiceCallList

传参方式：POST

备注：暂无

请求参数

Headers：

Body：

返回数据

请求示例

{
    "nodeEui": "009569BC3738",
    "page": 1,
    "pageSize": 1,
    "search": "call_scene"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "id": "27c0f901-0eca-416a-9290-1f1b68ef5619",
                "time": "2022-05-16T06:36:21.931Z",
                "companyId": "F192AA50",
                "productId": "ED9322C2",
                "nodeEui": "009569BC3738",
                "identifier": "call_scene",
                "name": "场景调用",
                "inputData": "{\"index\":\"20000000003\"}",
                "ouputData": null
            }
        ],
        "pages": 4,
        "current": 1,
        "size": 10,
        "searchCount": true,
        "total": 32,
        "optimizeCount": true,
        "offset": 0,
        "limit": 2147483647,
        "asc": true,
        "orderByField": null
    }
}

分页查询事件

接口名称：分页查询事件

接口描述：该接口用于分页查询设备事件上报的历史

请求地址：/api/senthink/aep/openApi/model/v1/getEventReportList

传参方式：POST

备注：暂无

请求参数

Headers：

Body：

返回数据

请求示例

{
    "nodeEui": "mqttModelHex2022",
    "page": 1,
    "pageSize": 1,
    "search": "sum"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "data": {
            "records": [],
            "pages": 1,
            "current": 1,
            "size": 10,
            "searchCount": true,
            "total": 0,
            "optimizeCount": true,
            "offset": 0,
            "limit": 2147483647,
            "asc": true,
            "orderByField": null
        },
        "optEnum": {
            "warn": "告警",
            "erro": "紧急",
            "info": "普通"
        }
    }
}

固件管理

添加小固件(表单格式)

接口名称： 添加小固件

接口描述： 添加小固件

请求地址： /api/senthink/aep/openApi/firmware/v1/add

传参方式：POST

备注：

• 添加固件接口，sign值计算方法与通用签名计算方法不同，请参考如何调用API中固件上传签名计算示例
• 该接口适合上传较小固件，大小限制在50MB以内

请求参数

Headers：

form-data参数:

返回数据

data 结构如下

请求示例

参数格式为form-data

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "firmwareId": "603735ebee27c95a9c9ed3dd",
    "createAt": "2021-02-25 13:30:18"
  }
}

错误码

获取OSS文件上传STS凭证

接口名称： 获取OSS文件上传STS凭证

接口描述： 对于比较大的固件，考虑到其上传会消耗大量的时间，而造成的用户体验感降低，平台开放接口，授权STS凭证给用户，用户拿着STS凭证即可直接把文件上传到OSS服务器 ，而不经过平台的转发

请求地址： /api/senthink/aep/openApi/oss/v1/fileUpload/getStsCredit

传参方式：POST

备注： STS凭证具有有效期，用户应在有效期内使用STS凭证完成文件上传，否则需要重新获取

请求参数

Headers：

Body:

返回数据

data数据结构如下：

请求示例

{
    "type": 3
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "endPoint": "oss-cn-zhangjiakou.aliyuncs.com",
        "accessKeyId": "STS.NUFecVWgdmnFT2H2RJkQhphp7",
        "accessKeySecret": "9kyzn7SxFfAUdEVtNA382GD7vYZJxsYGasoMeaDjiAT8",
        "stsToken": "CAISqQJ1q6Ft5B2yfSjIr5bzLtniurhF2qytVhT51lIfZ95En63b1Tz2IHFMeXZuCOkXs/0znGxS7vgTlrxpQppyWFfJd/xr449M8ASnVIzIvsHtDBiObi7iSwapEBfe8JL4foeQFaHFGJqEb1TDiVU8o9/TfimjWFqIKICAjYUdAP0cQgi/a0ghZrJRPRAwkNIGEnHTOP2xSEiI5FDdF011oAFxpHpi4KCkuK2m5wHZkUfxx51fxcz4KYP2aNJ3btUtEYWp0fdqM7HM1jJQ6h5Jsbd3i7ADuxW/54DMUwMLukrabbGMqIAydzUUPPZqR/R2y9HnjuB9t+DpkID69g1AJ+k9UV6EFdj9n5WVQbL0b4phKeyjZSXXsMqGM57uqBMlZm4LhbfZmUbihBQagAFsIFuMU7JdhU7sbKPmLKJDCuE1bpdDmTCl7GaivGpglfNHYIyvYDhxTGUKbnxjRelA/5kKrqq8UbZH5WID03iZXOLSB3TaNDdb9xOrJQqh74bIN08Ym6Cc+AbspiLAVt8sHifbXXa7RoIMQ9s4j37GudtfVLnowTXsr5jdgothmw==",
        "expiation": 1639366305000,
        "bucket": "test-senthink-xiot",
        "deviceCertificateDir": "",
        "otaFirmwareDir": "",
        "deviceLocalLogDir": "deviceLocalLog"
    }
}

使用STS凭证上传大文件示例

• 后端服务接口：

/**
* @param 文件
*/
@PostMapping("/test")
public String testUpload(@RequestBody MultipartFile file) throws IOException {

    //OSS域名
    String endPoint = "oss-cn-zhangjiakou.aliyuncs.com";

    //临时秘钥ID
    String accessKeyId = "STS.NUiiET5QNWYg6SmFU8PH19tco";

    //临时秘钥
    String accessKeySecret = "A6itEMiLHZgMHaBKvbZJKnySTADYLFnj3fd3eu2MKMQ7";

    //临时stsToken
    String stsToken = "CAISvQJ1q6Ft5B2yfSjIr5bcIv/g2I5v4JuMNHXcolVtXMcd1rHIjTz2IHFMeXZuCOkXs/" +
        "0znGxS7vgTlrxpQppyWFfJd/xr449M8ASnVIzIvsHtW2GqZyniSwapEBfe8JL4g4ybJYqvkJ7PBnnAkih" +
        "su+qYERypQ12iN7CQlJdjda55dwKkbD1Adp40Qwx5s50iKGf2P/SgOQKI+m3LFxhQpxZbg2Fy4riW6enmvHi" +
        "4tlDhzfIPrIncO4Wta9IWXK1ySNCoxud7BOCjmCdb8EpN77wkzv4GqyvKpc3YGFRX/xWHNemR4txoMEg7RNBjS" +
        "v8U9qKlyqEm4bSJytms8XsXY7EJCRa4bZu73c7JFNmuMtsEbrvhMxzPqIvebsSq7VJ9MC9CaFsWIYJ/e2USExUpTS" +
        "rBOq6g5EB71pRB12sruxqAAUiGNHBhvhUF7FgEBMwNVydwuJ9PHgojndyKlJFnyHkvTxEchEw8mYbVw8a0hf9Bh3HNmkCe" +
        "16OIXXDQD0A0IL0bg6Syq0i9wW29/uwjpJEg1CoVfu5lmWE9f9DpzYqizC+/ZWds1NP6m8wKbMvM806LZioRJ2LeKXjKPvrSkmnm";

    //OSS桶
    String bucket = "test-senthink-xiot";

    //文件存储目录
    String fileDir = "otaFirmwareDir";

    //验证文件不为空
    if (file == null || file.isEmpty()) {
        return "操作失败：文件为空";
    }

    //设置协议为https
    ClientBuilderConfiguration configuration = new ClientBuilderConfiguration();
    configuration.setProtocol(Protocol.HTTPS);

    //初始化OSS客户端
    OSS oss = new OSSClientBuilder().build(endPoint,
                                           accessKeyId,
                                           accessKeySecret,
                                           stsToken,
                                           configuration);

    //文件标识
    String fileKey = fileDir + "/" + System.currentTimeMillis() + file.getOriginalFilename();

    //上传文件
    oss.putObject(bucket,fileKey , new ByteArrayInputStream(file.getBytes()));

    //设置文件的访问权限为公共读
    oss.setObjectAcl(bucket,fileKey, CannedAccessControlList.PublicRead);

    //设置过期时间100年(用户可以按照需求自行设置),
    Date expiration = new Date(System.currentTimeMillis() + 60 * 1000L * 60 * 24);

    //获取文件的访问地址
    String url = oss.generatePresignedUrl(bucket, fileKey, expiration).toString();
    return url;
}

• 前端测试：使用postman测试如下

添加大固件(JSON格式)

接口名称： 添加大固件 接口描述： 添加大固件

请求地址： /api/senthink/aep/openApi/firmware/v1/addLargeFirmware

传参方式：POST

备注：

• 调用该接口保存固件信息时，用户需按顺序完成以下操作：

  1. 已经调用平台开放的获取STS凭证的接口获取到了STS凭证
  2. 在凭证有效期内完成固件的上传(阿里云文档地址https://help.aliyun.com/document_detail/84778.html)

  PS：流程可以参考平台开放的获取OSS文件上传STS凭证接口

• 该接口的固件大小限制在200MB以内，在请求该接口保存固件信息时会去OSS服务器上验证文件大小，超过200MB不允许保存，且平台会定时删除OSS上超过200MB的文件

请求参数

Headers：

Body:

计算文件md5

• 为了保证文件传输过程中的安全性，使用md5校验文件内容是否被篡改
• 文件内容相同的文件，md5值一定相同
• 计算md5方式和工具有很多，这里以Java为例 ，使用jdk自带的类来计算文件的md5值，用户可以自行选择其他计算文件的md5的方式和工具

public static void main(String[] args) throws FileNotFoundException {
    File file = new File("文件路径");
    FileInputStream inputStream = new FileInputStream(file);
    byte[] digest = null;

    try {
        MessageDigest messageDigest = MessageDigest.getInstance("MD5");
        int bufferLength = 8 * 1024;
        byte[] buffer = new byte[bufferLength];
        int read = inputStream.read(buffer, 0, bufferLength);

        while (read > -1) {
            messageDigest.update(buffer, 0, read);
            read = inputStream.read(buffer, 0, bufferLength);
        }
        //关闭流
        inputStream.close();
        digest = messageDigest.digest();
    } catch (Exception e) {
        throw new RuntimeException(e);
    }

    String md5 = new BigInteger(1, digest).toString(16);
    System.out.println(md5);

}

计算md5示例：

ee1fbecf7b1e8d90642e638a14cf111a

返回数据

请求示例

{
    "name": "2021/12/13测试固件",
    "productId": "2D8DA198",
    "module": "test_lei",
    "softVer": "softVer1.0",
    "signMethod": "md5",
    "path": "https://test-senthink-xiot.oss-cn-zhangjiakou.aliyuncs.com/otaFirmware/test.bin",
    "fileKey": "otaFirmware/test.bin",
    "originalFilename": "test.bin",
    "md5": "2677e2fad59ddbcf3268bb931b8a7b0e"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "firmwareId": "61bd8c9cf369ec56debb8f24",
        "createAt": "2021-12-18 15:24:12"
    }
}

删除固件

接口名称： 删除固件 接口描述： 删除固件

请求地址： /api/senthink/aep/openApi/firmware/v1/delete 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

请求示例

{
  "id": "600543146c41da741aac23df"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

错误码

编辑固件

接口名称： 编辑固件 接口描述： 编辑固件

请求地址： /api/senthink/aep/openApi/firmware/v1/edit 传参方式：POST

备注： 无

请求参数

Headers：

form-data参数:

返回数据

请求示例

{
  "id": "5feaa128c8334e480490a2ec",
  "name": "固件-SC-V1.0.1",
  "remark": "智能电动车1.0.1版本固件，添加了电子围栏功能"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

错误码

固件分页查询

接口名称： 固件分页查询 接口描述： 固件分页查询 请求地址： /api/senthink/aep/openApi/firmware/v1/getByPage 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

data的数据结构为：

FirmwareInfo 结构如下

请求示例

{
  "page": 1,
  "pageSize": 10,
  "productId": "11765942"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "records": [
      {
        "id": "603735ebee27c95a9c9ed3dd",
        "name": "api测试上传",
        "productId": "11765942",
        "productName": "TCP产品",
        "hardVer": "V2.0.0",
        "softVer": "V1.1.1",
        "signMethod": "md5",
        "size": 767,
        "remark": "api修改固件备注333",
        "md5": "61527576c5634030ab82af14baddddf8",
        "originalFilename": "cat1_8910_qhq_fota_0129B (2).pack",
        "fileKey": "otaFirmware/1614231019118_cat1_8910_qhq_fota_0129B (2).pack",
        "createAt": "2021-02-25 13:30:18"
      }
    ],
    "pages": 1,
    "current": 1,
    "size": 3,
    "total": 1
  }
}

固件详情

接口名称： 固件详情 接口描述： 固件详情

请求地址： /api/senthink/aep/openApi/firmware/v1/query 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

data的数据结构为：

请求示例

{
  "id": "600543146c41da741aac23df"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "id": "603735ebee27c95a9c9ed3dd",
    "name": "api测试上传",
    "productId": "11765942",
    "productName": "TCP产品",
    "hardVer": "V2.0.0",
    "softVer": "V1.1.1",
    "signMethod": "md5",
    "size": 767,
    "remark": "api修改固件备注333",
    "md5": "61527576c5634030ab82af14baddddf8",
    "originalFilename": "cat1_8910_qhq_fota_0129B (2).pack",
    "fileKey": "otaFirmware/1614231019118_cat1_8910_qhq_fota_0129B (2).pack",
    "createAt": "2021-02-25 13:30:18"
  }
}

错误码

设备升级管理

创建OtaPlan升级计划

接口名称： 建OtaPlan升级计划 接口描述： OtaPlan表示升级计划，OtaTask表示升级任务，一个OtaPlan下有多个OtaTask

请求地址： /api/senthink/aep/openApi/ota/v1/otaNotify/createOtaPlan/assign 传参方式：POST

备注： 指定设备创建ota升级计划

请求参数

Headers：

Body:

返回数据

data结构：

OtaTask创建结果状态码详情如下：

请求示例

{
    "firmwareId": "6156cccbc6958b030881aeac",
    "nodes": ["30008","30007","30005","30009"],
    "notifyType": 0,
    "startAt": "",
    "endAt": "",
    "retryInterval": 0,
    "retryLimit": null,
    "overwrite": 0,
    "triggerType":1,
    "remark": "",
    "expireTime": null
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "data": [
            {
                "taskId": "61a0a765f93e045437bea437",
                "nodeEui": "MY0000000999",
                "downId": "980E8A0F",
                "status": 0
            },
            {
                "taskId": "61a0a765f93e045437bea438",
                "nodeEui": "MQTT000000111",
                "downId": "425EB93E",
                "status": 0
            }
        ],
        "batchUuid": "dea96254-b778-48ec-bfe4-b853aa8c5632",
        "flag": true
    }
}

错误码

取消升级计划OtaPlan

接口名称： 取消升级计划OtaPlan 接口描述： 取消升级计划OtaPlan 请求地址： /api/senthink/aep/openApi/ota/v1/otaNotify/cancel 传参方式：POST 备注：该操作会取消一个OtaPlan下的所有待推送的OtaTask

请求参数

Headers：

Body:

返回数据

请求示例

{
    "id": "306134d4-050d-4800-a8ab-8bce88b1db43"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": null
}

错误码

取消/重新升级OtaTask

接口名称：取消/重新升级

接口描述：只有待推送的OtaTask才可以被取消，只有已取消和升级失败的OtaTask才可以被重新升级

请求地址：/api/senthink/aep/openApi/ota/v1/otaNotify/cancelOrReCreate

传参方式：POST

备注：OtaTask状态有如下几种：

请求参数

Headers：

Body：

返回数据

请求示例

{
  "id": "601bff8b5b3bb45bef53c230,601bff8b5b3bb45bef53c231",
  "opt": 0
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

分页查询升级计划OtaPlan

接口名称： 升级计划分页查询 接口描述： 升级计划分页查询

请求地址： /api/senthink/aep/openApi/ota/v1/otaNotify/getOtaPlanByPage 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

data的数据结构为：

OtaTask结构如下：

请求示例

{
  "firmwareId": "603735ebee27c95a9c9ed3dd",
  "page": 1,
  "pageSize": 10
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "data": {
      "records": [
        {
          "id": "604f16444d79652be74210f1",
          "companyId": "BDBF832D",
          "productId": "11765942",
          "productName": "TCP产品",
          "firmwareId": "603735ebee27c95a9c9ed3dd",
          "strategy": 0,
          "scope": 0,
          "softVerScope": [
            "v1.0.0"
          ],
          "notifyType": 0,
          "startAt": "2021-03-14T16:00:00.000+0000",
          "endAt": "2021-04-14T16:00:00.000+0000",
          "retryInterval": 1,
          "retryLimit": 2,
          "expireTime": 30,
          "overwrite": 1,
          "status": 0,
          "remark": "这是备注",
          "createAt": "2021-03-15 16:09:40",
          "updateAt": "2021-03-15 16:09:40"
        }
      ],
      "pages": 1,
      "current": 1,
      "size": 10,
      "searchCount": true,
      "total": 1,
      "optimizeCount": true,
      "offset": 0,
      "limit": 2147483647,
      "asc": true,
      "orderByField": null
    },
    "statusEnum": {
      "0": "升级中",
      "1": "已完成",
      "2": "已取消"
    },
    "strategyEnum": {
      "0": "静态升级",
      "1": "动态升级"
    },
    "scopeEnum": {
      "0": "指定设备",
      "1": "全部设备"
    }
  }
}

错误码

分页查询升级计划下的升级任务

接口名称： 升级计划下升级任务分页查询 接口描述： 一个升级计划下升级任务分页查询(一个升级计划对应零到多个升级任务)

请求地址： /api/senthink/aep/openApi/ota/v1/otaNotify/otaPlanTaskByPage 传参方式：POST

备注： 无

请求参数

Headers：

Body:

返回数据

data的数据结构为： | 名称 | 类型 | 备注 | 其他信息 | | :------------ | :------------ | :--------------------------------- | :------- | | data | object | 数据 | | | otaTypeEnum | enum | 升级方式枚举 | | | otaStatusEnum | enum | 升级状态枚举 | |

data.data 的数据结构为 | 名称 | 类型 | 备注 | 其他信息 | | :------------ | :------------ | :--------------------------------- | :------- | | current | integer | 当前页数 | | | pages | integer | 总页数 | | | records | List | 查询到的结果集 | | | size | integer | 每页显示数量 | | | total | integer | 数据总数（所有页） | | | scopeEnum | enum | 升级范围枚举 | | | statusEnum | enum | 升级计划枚举 | | | strategyEnum | enum | 升级策略枚举 | |

OtaTask结构如下：

请求示例

{
  "planId": "60e1a72d74a8941a40d42d42",
  "page": 1,
  "pageSize": 10
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": {
    "data": {
      "records": [
        {
          "id": "60e1a72d74a8941a40d42d43",
          "planId": "60e1a72d74a8941a40d42d42",
          "companyId": "B5869C8F",
          "firmwareId": "609bb7daf2a6f7261142bd22",
          "productId": "92B54688",
          "productName": "mqttOta测试",
          "nodeEui": "100006",
          "downId": "8B61D137",
          "softVer": "v1.0.5",
          "hardVer": "",
          "targetSoftVer": "v1.0.1",
          "otaType": 2,
          "startAt": "2021-07-04T12:18:53.576+0000",
          "endAt": null,
          "expireAt": 1625487533707,
          "status": 0,
          "retryInterval": 0,
          "retryLimit": null,
          "retryCnt": 1,
          "overwrite": 1,
          "createdStrategy": 0,
          "errorInfo": null,
          "createAt": "2021-07-04 20:18:53",
          "updateAt": "2021-07-04 20:18:53"
        }
      ],
      "pages": 1,
      "current": 1,
      "size": 10,
      "searchCount": true,
      "total": 1,
      "optimizeCount": true,
      "offset": 0,
      "limit": 2147483647,
      "asc": true,
      "orderByField": null
    },
    "otaTypeEnum": {
      "1": "TCP",
      "2": "HTTP"
    },
    "otaStatusEnum": {
      "0": "待推送",
      "-1": "已删除",
      "1": "已推送",
      "2": "升级中",
      "3": "升级成功",
      "4": "升级失败",
      "5": "已取消"
    }
  }
}

错误码

查询OtaPlan详情

接口名称：查询OtaPlan详情

接口描述：无

接口地址：/api/senthink/aep/openApi/ota/v1/otaNotify/otaPlanInfo

传参方式：POST

备注：无

请求参数

Headers：

Body：

返回数据

请求示例