API 管理

平台开放的第三方对接API接口列表，为外部系统（如企业ERP、自定义应用）提供接口对接依据，实现平台数据与外部系统的互通。

通过菜单【系统管理】->【API管理】进入API管理页面。在该页面可查看平台对外开发的API接口。

API

API接口说明

本节将介绍平台API的接口及返回格式

登录接口

请求方式：POST

请求参数

名称	类型	是否必填	备注
userName	string	必填	用户名
pwd	string	必填	密码

返回参数

名称	类型	备注
code	int	返回码
msg	string	返回消息
data	object	数据

返回参数（data）

名称	类型	备注
user	object	用户信息
access_token	string	Token

返回参数（user）

名称	类型	备注
userName	string	用户名
unitId	string	用户所属机构ID
unit	string	用户所属机构名称
roleId	string	用户角色ID
role	sting	用户角色名称

示例

{
    "code": 0,
    "msg": "登录成功",
    "count": 0,
    "data": {
        "user": {
            "userName": "test",
            "unitId": "b80dfc40-b28b-4574-90e7-3105cb1cfd21",
            "unit": "公司名称",
            "roleId": "20000000-0000-0000-0000-000000000001",
            "role": "机构管理员"
        },
        "access_token": "0cd9d7ba-0fad-7b83-7072-af5266835194"
    }
}

获取设备列表

请求方式：GET

请求头

名称	类型	是否必填	备注
access_token	string	必填	登录接口返回的access_token

请求参数

名称	类型	是否必填	备注
unitId	string	可选	机构ID
devName	string	可选	设备名称
page	int	必填	页码
limit	int	必填	每页的条数

返回参数

名称	类型	备注
code	int	返回码
msg	string	返回消息
count	int	返回条数
data	array	数据

返回参数（data）

名称	类型	备注
scode	string	设备SN号
sname	string	设备名称
stype	string	设备类型
project	string	设备所属项目ID
projectName	string	设备所属项目
locateMode	bool	是否自动定位
longitude	decimal	经度
latitude	decimal	维度
address	string	设备安装地址
status	int	设备状态
type	string	设备型号
versions	string	设备软件版本
element	array	设备绑定传感器ID

示例

{
    "code": 0,
    "msg": "ok",
    "count": 10,
    "data": [
        {
            "scode": "8C877802-4320A706-815703BF-7C9CCE96",
            "sname": "4G",
            "stype": "",
            "project": "f053b4b5-85c6-4855-8ac9-6cddf3a27478",
            "projectName": "twes",
            "locateMode": true,
            "longitude": 114.4447469,
            "latitude": 38.0249642,
            "address": "",
            "status": 0,
            "type": "HW1570G-A",
            "versions": "7.0.3",
            "element": [
                "9f24964c-b3c5-4b91-9392-d3a9ef54b465",
                "babf0576-e8e2-4bfd-947d-5c9e2b6506f8"
            ]
        }
  ]
}

获取设备传感器信息

请求参数：GET

请求头

名称	类型	是否必填	备注
access_token	string	必填	登录接口返回的access_token

请求参数

名称	类型	是否必填	备注
scode	string	必填	设备SN号
sensorId	string	可选	传感器

返回参数

名称	类型	备注
code	int	返回码
msg	string	返回消息
data	array	数据

返回参数（data）

名称	类型	备注
scode	string	设备SN号
id	string	传感器ID
sensorName	string	传感器名称
variateList	array	变量列表

返回参数（variateList）

名称	类型	备注
naem	string	变量名称
title	string	变量值，查询数据时用
units	string	单位

示例

{
    "code": 0,
    "msg": "ok",
    "count": 2,
    "data": [
        {
            "scode": "8C877802-4320A706-815703BF-7C9CCE96",
            "id": "9f24964c-b3c5-4b91-9392-d3a9ef54b465",
            "sensorName": "温湿度传感器",
            "variateList": [
                {
                    "name": "温度",
                    "title": "wendu",
                    "units": "℃"
                }
            ]
        }
    ]
}

获取设备传感器历史数据

注：该接口有调用限制，每分钟不能超过十次

请求方式：GET

请求头

名称	类型	是否必填	备注
access_token	string	必填	登录接口返回的access_token

请求参数

名称	类型	是否必填	备注
scode	string	必填	设备SN号
sensorId	string	必填	传感器ID
variate	string	可选	变量名称
startTime	string	必填	开始时间，格式为：YYYY-MM-DD
endTime	string	必填	结束时间，格式为：YYYY-MM-DD
page	int	必填	页码
limit	int	必填	每页的条数

返回参数

名称	类型	备注
code	int	返回码
msg	string	返回消息
data	object	数据

返回参数（data）

名称	类型	备注
scode	string	设备SN号
sensorList	array	传感器列表

返回参数（sensorList）

名称	类型	备注
id	string	传感器ID
sensorName	string	传感器名称
variateList	array	变量列表

返回参数（variateList）

名称	类型	备注
name	string	变量名称
title	string	变量值
count	int	数据总数
data	array	数据列表

返回参数（data）

名称	类型	备注
value	decimal	值
creationTime	string	时间

示例

{
    "code": 0,
    "msg": "ok",
    "count": 0,
    "data": {
        "scode": "41F7C774-6EF04AB6-046D52B4-5F810887",
        "sensorList": [
            {
                "id": "9f24964c-b3c5-4b91-9392-d3a9ef54b465",
                "sensorName": "温湿度传感器",
                "variateList": [
                    {
                        "name": "温度",
                        "title": "wendu",
                        "count": 5,
                        "data": [
                            {
                                "value": 29.299999237,
                                "creationTime": "2024/07/17 16:08:10"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

获取设备传感器最新数据

注：该接口有调用限制，每分钟不能超过十次

请求方式：GET

请求头：

名称	类型	是否必填	备注
access_token	string	必填	登录接口返回的access_token

请求参数

名称	类型	是否必填	备注
scode	string	必填	设备SN号
sensorId	string	必填	传感器ID
variate	string	可选	变量名称

返回参数

名称	类型	备注
code	int	返回码
msg	string	返回消息
data	array	数据

返回参数（data）

名称	类型	备注
scode	string	设备SN号
sensorList	array	传感器列表

返回参数（sensorList）

名称	类型	备注
id	string	传感器ID
sensorName	string	传感器名称
variateList	array	变量列表

返回参数（variateList）

名称	类型	备注
name	string	变量名称
title	string	变量值
value	decimal	值
creationTime	string	时间

示例

{
    "code": 0,
    "msg": "ok",
    "count": 0,
    "data": {
        "scode": "41F7C774-6EF04AB6-046D52B4-5F810887",
        "sensorList": [
            {
                "id": "9f24964c-b3c5-4b91-9392-d3a9ef54b465",
                "sensorName": "温湿度传感器",
                "variateList": [
                    {
                        "name": "温度",
                        "title": "wendu",
                        "value": 29.299999237,
                        "creationTime": "2024/07/17 16:08:10"
                    }
                ]
            }
        ]
    }
}

传感器数据写入

请求方式：POST

请求头

名称	类型	是否必填	备注
access_token	string	必填	登录接口返回的access_token

请求参数

名称	类型	是否必填	备注
scode	string	必填	设备SN号
sensorId	string	必填	传感器ID
variate	string	必填	变量标题
value	int	必填	下发的值

返回参数

名称	类型	备注
code	int	返回码
msg	string	返回消息
data	null	无返回数据

示例

{
    "code": 0,
    "msg": "ok",
    "count": 0,
    "data": null
}

API接口说明​

登录接口​

获取设备列表​

获取设备传感器信息​

获取设备传感器历史数据​

获取设备传感器最新数据​

传感器数据写入​

API接口说明

登录接口

获取设备列表

获取设备传感器信息

获取设备传感器历史数据

获取设备传感器最新数据

传感器数据写入