这是标题


  • 我的第一个接口文档:


title: 个人项目 language_tabs:

  • shell: Shell
  • http: HTTP
  • javascript: JavaScript
  • ruby: Ruby
  • python: Python
  • php: PHP
  • java: Java
  • go: Go toc_footers: [] includes: [] search: true code_clipboard: true highlight_theme: darkula headingLevel: 2 generator: “@tarslib/widdershins v4.0.23”

个人项目

Base URLs:

Authentication

smart-iot

POST 令牌生成接口

POST /iot/waterDeviceInfo/supply/generatedToken

物联网厂家账户令牌生成接口

Body 请求参数

{
  "account": "supac_ex",
  "password": "3ecee66344e199ffcb3feebcdb91b25e"
}

请求参数

名称位置类型必选说明
bodybodyobjectnone
» accountbodystring账户
» passwordbodystring密码

返回示例

{
  "result": "3E3mfo1Jih9SaTGKqCBT6s1MZbN0p1C+VgMsJDbl87k=",
  "code": 200,
  "message": "success"
}
{
  "code": 1001,
  "message": "account null"
}
{
  "code": 1002,
  "message": "password null"
}
{
  "code": 1003,
  "message": "account or password, wrong or not exist"
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» resultstringfalsenonenone
» codeintegerfalsenonenone
» messagestringfalsenonenone

POST 设备数据更新

POST /iot/waterDeviceInfo/update/byDeviceCode

Body 请求参数

{
  "deviceCode": "123456789",
  "cumFlowNum": 123.4,
  "updateTime": "2024-10-29 00:00:00",
  "status": 16
}

请求参数

名称位置类型必选说明
Authorizationheaderstring令牌
bodybodyobjectnone
» deviceCodebodystring设备编码(唯一)
» deviceNobodystring¦null厂家端id
» insFlowNumbodynumber(double)¦null瞬间流量
» cumFlowNumbodynumber(double)累计流量
» updateTimebodystring(date-time)上报时间(yyyy-MM-dd HH:mm:ss)
» lastSignalTimebodystring(date-time)¦null最近上线时间(yyyy-MM-dd HH:mm:ss)
» statusbodyinteger(int32)设备状态(16:在线,17:离线,18:异常)
» batteryStatusbodyinteger(int32)¦null电池状态(101:正常,102:异常)
» batteryVoltagebodynumber(double)¦null电池电压
» batteryPercentagebodynumber(double)¦null电量百分比
» lngbodynumber(double)¦null经度
» latbodynumber(double)¦null纬度

枚举值

属性
» status16
» status17
» status18
» batteryStatus101
» batteryStatus102

返回示例

{
  "result": "update down",
  "code": 200,
  "message": "success"
}
{
  "code": 1011,
  "message": "token not exist"
}
{
  "code": 1020,
  "message": "deviceCode null"
}
{
  "code": 1030,
  "message": "cumFlowNum null"
}
{
  "code": 1040,
  "message": "updateTime null"
}
{
  "code": 1041,
  "message": "updateTime fail"
}
{
  "code": 1050,
  "message": "status null"
}
{
  "code": 1051,
  "message": "status fail"
}
{
  "code": 1060,
  "message": "device not exist,please check the deviceCode"
}
{
  "code": 1070,
  "message": "fail to update"
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» resultstringfalsenonenone
» codeintegertruenonenone
» messagestringtruenonenone