这是标题
-
我的第一个接口文档:
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"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
» account | body | string | 是 | 账户 |
» password | body | string | 是 | 密码 |
返回示例
{
"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"
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | none | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» result | string | false | none | none | |
» code | integer | false | none | none | |
» message | string | false | none | none |
POST 设备数据更新
POST /iot/waterDeviceInfo/update/byDeviceCode
Body 请求参数
{
"deviceCode": "123456789",
"cumFlowNum": 123.4,
"updateTime": "2024-10-29 00:00:00",
"status": 16
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Authorization | header | string | 是 | 令牌 |
body | body | object | 否 | none |
» deviceCode | body | string | 是 | 设备编码(唯一) |
» deviceNo | body | string¦null | 否 | 厂家端id |
» insFlowNum | body | number(double)¦null | 否 | 瞬间流量 |
» cumFlowNum | body | number(double) | 是 | 累计流量 |
» updateTime | body | string(date-time) | 是 | 上报时间(yyyy-MM-dd HH:mm:ss) |
» lastSignalTime | body | string(date-time)¦null | 否 | 最近上线时间(yyyy-MM-dd HH:mm:ss) |
» status | body | integer(int32) | 是 | 设备状态(16:在线,17:离线,18:异常) |
» batteryStatus | body | integer(int32)¦null | 否 | 电池状态(101:正常,102:异常) |
» batteryVoltage | body | number(double)¦null | 否 | 电池电压 |
» batteryPercentage | body | number(double)¦null | 否 | 电量百分比 |
» lng | body | number(double)¦null | 否 | 经度 |
» lat | body | number(double)¦null | 否 | 纬度 |
枚举值
属性 | 值 |
---|---|
» status | 16 |
» status | 17 |
» status | 18 |
» batteryStatus | 101 |
» batteryStatus | 102 |
返回示例
{
"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"
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | none | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» result | string | false | none | none | |
» code | integer | true | none | none | |
» message | string | true | none | none |