设备管理服务平台

数据类型

设备终端接口服务

服务端地址获取

广播服务端口: 8074

广播客户端口: 8073

请求方式: UDP

内容类型: application/json;charset=utf-8

简要描述: 服务端地址获取

广播参数:

请求样例:

{
"deviceNum":"12345678"
}

响应参数:

响应消息样例:

{
    "msg":"获取服务端地址成功",
    "code":1,
    "data":{
        "ip":"192.168.0.98",
        "port":11091,,
        "deviceRegisterApi":"/m/api/register",
        "deviceInitApi":"/m/api/deviceInit",
        "deviceUpdateApi":"/m/api/deviceUpdate"
    }
}

设备注册

请求URL: m/api/register

请求方式: POST

内容类型: application/json;charset=utf-8

简要描述: 设备注册，成功返回响应rabbmit连接参数,如未找到该设备，系统会根据设备码创建新设备

请求参数:

请求样例:

{
    "deviceCode":"a12345678",
    "deviceVersion":"1"
}

响应参数:

content解密参数:

响应消息样例:

{
    "code":1,
    "data":{
        "content":"hRNPu+V1hc4lGRHtXGyVOF0U7ez8/ZxFke9L4o7DWVLMfsZwkViAChfLKSydAEWAdsbgP1dzfNrQTq7X0diu1awR/qdPNcDcpj5/hBozLn+OmuTKLUWhq9+WGtuoF3BTbtIpWkpQWDGolOCfRadenGUkuMozjEwwkt5CIDa+nzOqh56BJIhGahlx79Qt30ugj3UNhLTfvw5lpN9jY7u+icx+xnCRWIAKF8spLJ0ARYAbMXXhI21dYty7e1b+Cb2wZobupPyXRmyuy8Fkn4bculmkCywq78F6tPlu0rCCgJA="
    }
}

设备初始化信息

请求URL: m/api/deviceInit

请求方式: GET

内容类型: application/json;charset=utf-8

简要描述: 设备初始化信息，提供手机编辑设备入口信息

请求参数:

请求样例:

{}

响应参数:

响应消息样例:

{
  "code": 1,
  "data": {
    "firmList": [
      {
        "deviceFirmId": 1,
        "deviceFirmname": "四川新鸿翔"
      }
    ],
    "productList": [
      {
        "productCode": "pdj",
        "productId": 1,
        "productName": "排队机"
      },
      {
        "productCode": "ckp",
        "productId": 2,
        "productName": "窗口屏"
      }
    ],
    "siteList": [
      {
        "siteCode": "510105521000-0001",
        "siteId": 1,
        "siteName": "测试站点1"
      },
      {
        "siteCode": "513400000000-0001",
        "siteId": 2,
        "siteName": "凉山州行政审批局"
      }
    ]
  }
}

设备新增或更新

请求URL: m/api/deviceUpdate

请求方式: POST

内容类型: application/json;charset=utf-8

简要描述: 设备新增或更新，提供给前端手机页面更新设备操作

请求参数:

请求样例:

{
    "deviceName":"agpla8",
    "deviceCode":"a1-a2",
    "deviceMac":"a1-a2",
    "siteId":1,
    "siteCode":"510105521000-0001",
    "siteName":"测试站点1",
    "productId":1,
    "deviceFirmId":1,
    "lon":"12",
    "lati":"22",
    "deviceInBuilding":13,
    "deviceInFloor":22,
    "defectsLiabilityPeriod":"2022-06-30",
    "leadingOfficial":"张三",
    "leadingOfficialTelephone":"13281114856",
    "source":1,
    "active":1
}

响应参数:

content解密参数:

响应消息样例:

{
    "code":1,
    "data":{
        "content":"hRNPu+V1hc4lGRHtXGyVOF0U7ez8/ZxFke9L4o7DWVLMfsZwkViAChfLKSydAEWAdsbgP1dzfNrQTq7X0diu1awR/qdPNcDcpj5/hBozLn+OmuTKLUWhq9+WGtuoF3BTbtIpWkpQWDGolOCfRadenGUkuMozjEwwkt5CIDa+nzOqh56BJIhGahlx79Qt30ugj3UNhLTfvw5lpN9jY7u+icx+xnCRWIAKF8spLJ0ARYAbMXXhI21dYty7e1b+Cb2wZobupPyXRmyuy8Fkn4bculmkCywq78F6tPlu0rCCgJA="
    }
}

设备版本检查

请求URL: m/api/checkVersion

请求方式: POST

内容类型: application/json;charset=utf-8

简要描述: 检查当前设备所属版本最新版本信息

请求参数:

请求样例:

{
    "deviceCode":"a12345678"
}

响应参数:

content解密参数:

响应消息样例:

{
    "code":1,
    "data":{
        "content":"hRNPu+V1hc4lGRHtXGyVOF0U7ez8/ZxFke9L4o7DWVLMfsZwkViAChfLKSydAEWAdsbgP1dzfNrQTq7X0diu1awR/qdPNcDcpj5/hBozLn+OmuTKLUWhq9+WGtuoF3BTbtIpWkpQWDGolOCfRadenGUkuMozjEwwkt5CIDa+nzOqh56BJIhGahlx79Qt30ugj3UNhLTfvw5lpN9jY7u+icx+xnCRWIAKF8spLJ0ARYAbMXXhI21dYty7e1b+Cb2wZobupPyXRmyuy8Fkn4bculmkCywq78F6tPlu0rCCgJA="
    }
}

对外平台接口服务

获取接口访问token

请求URL: m/api/getToken

请求方式: POST

内容类型: application/json;charset=utf-8

简要描述: 获取接口访问token

请求参数:

请求样例:

响应参数:

响应消息样例:

接收第三方平台设备消息

请求URL: m/api/receive

请求方式: POST

鉴权头信息: Authorization: {{token}}

内容类型: application/json;charset=utf-8

简要描述:

请求参数:

请求样例:

{}

响应参数:

响应消息样例:

接收第三方平台命令消息

请求URL: m/api/callback

请求方式: POST

内容类型: application/json;charset=utf-8

简要描述: 以数组方式进行提交

请求参数:

请求样例:

[
    {
        "data":"{xxxx}",
        "deviceCode":"a1",
        "messageType":"HEART_BEAT",
        "timestamp":1654656951795
    },
    {
        "data":"{bbbbbb}",
        "deviceCode":"a2",
        "messageType":"HEART_BEAT",
        "timestamp":1654656951795
    }
]

响应参数:

响应消息样例:

回调各个平台通知消息

请求URL: 各平台通知地址

请求方式: POST

内容类型: application/json;charset=utf-8

简要描述: 设备消息通知各个平台，当配置了地址时候

请求参数:

请求样例:

{}

响应参数:

响应消息样例:

设备消息

上行消息

topic: uploadTopicFilter

请求方式: rabbmitMQ

内容类型: application/json;charset=utf-8

简要描述: 上行消息存放队列

请求参数:

请求样例:

{
    "data":"YWJjZDEyMzQ=",
    "headers":{
        "data":{
            "protocol":"json",
            "messageType":"HEART_BEAT",
            "deviceCode":"A1:A2:A3:A4:A5:A6",
            "sign":"abcd1234",
            "timestamp":"2022-04-15 09:48:05"
        }
    },
    "key":"d3635cd0597d46c88b85797c3846b04f"
}

下行消息

topic: downTopicFilter

请求方式: rabbmitMQ

内容类型: application/json;charset=utf-8

简要描述: 下行消息存放队列

请求参数:

请求样例:

{
    "data":"YWJjZDEyMzQ=",
    "headers":{
        "data":{
            "protocol":"json",
            "messageType":"UPGREAD",
            "deviceCode":"A1:A2:A3:A4:A5:A6",
            "sign":"abcd1234",
            "downloadUrl":"http://xxxxx",
            "timestamp":"2022-04-15 09:48:05"
        }
    },
    "key":"d3635cd0597d46c88b85797c3846b04f"
}

码表

响应结果码表

附录

业务上行下行消息类型