API 接口文档

POST

check_user - 用户验证

action=check_user

验证用户身份，检查用户名和密码是否正确。

请求参数

参数名	类型	必需	描述
action	string	是	操作类型，固定为"check_user"
username	string	是	用户名
password	string	是	密码

响应示例

成功响应

错误响应

{
    "success": true,
    "uid": 12345,
    "status": 1
}
                    

{
    "error": "Invalid username or password",
    "code": 401,
    "timestamp": "2024-01-15T10:30:00+08:00",
    "success": false
}
                    

POST

update_seting - 更新设备设置

action=update_seting

更新设备设置信息，支持单个设备或多个设备批量更新。新增 status 参数用于控制设备状态。

请求参数

参数名	类型	必需	描述	默认值
action	string	是	操作类型，固定为"update_seting"	-
username	string	是	用户名	-
password	string	是	密码	-
device	string/array	是	设备标识，支持单个设备字符串或多个设备数组	-
status	int	否	设备状态：0=禁用，1=启用	0
outtime	int	否	超时时间（秒）	0
tip	string	否	设备提示信息	空字符串
amount	int	否	数量	0
isreply	int	否	是否回复：0=否，1=是	0
fun	string	否	功能标识	空字符串

响应示例

成功响应

错误响应

{
    "success": true,
    "message": "Updated 3 device(s) successfully, 0 failed",
    "uid": 12345,
    "total_affected_rows": 3,
    "device_results": {
        "device001": {
            "success": true,
            "affected_rows": 1
        },
        "device002": {
            "success": true,
            "affected_rows": 1
        },
        "device003": {
            "success": true,
            "affected_rows": 1
        }
    }
}
                    

{
    "error": "Device parameter is required and cannot be empty",
    "code": 400,
    "timestamp": "2024-01-15T10:30:00+08:00",
    "success": false,
    "details": {
        "received_device": "",
        "expected_format": "String or array of device identifiers"
    }
}
                    

注意：device 参数支持字符串和数组两种格式。如果是数组，将批量更新多个设备的设置。

POST

get_seting - 获取设备设置

action=get_seting

获取指定设备的设置信息。

请求参数

参数名	类型	必需	描述
action	string	是	操作类型，固定为"get_seting"
username	string	是	用户名
password	string	是	密码
device	string	是	设备标识

响应示例

成功响应

错误响应

{
    "success": true,
    "settings": {
        "outtime": 3600,
        "tip": "设备正常运行",
        "amount": 5,
        "isreply": 1,
        "fun": "auto_mode",
        "status": 1
    }
}
                    

{
    "error": "Settings not found for this device",
    "code": 404,
    "timestamp": "2024-01-15T10:30:00+08:00",
    "success": false
}
                    

POST

get_hs - 获取HS数据

action=get_hs

根据ID获取HS数据。

请求参数

参数名	类型	必需	描述
action	string	是	操作类型，固定为"get_hs"
id	int	是	HS数据ID

响应示例

成功响应

错误响应

{
    "success": true,
    "data": "HS数据内容"
}
                    

{
    "error": "HS data not found",
    "code": 404,
    "timestamp": "2024-01-15T10:30:00+08:00",
    "success": false
}
                    

POST

get_hs_by_user - 获取用户HS数据

action=get_hs_by_user

获取指定用户的所有HS数据。

请求参数

参数名	类型	必需	描述
action	string	是	操作类型，固定为"get_hs_by_user"
username	string	是	用户名

响应示例

成功响应

错误响应

{
    "success": true,
    "data": [
        {
            "id": 1,
            "data": "HS数据内容1"
        },
        {
            "id": 2,
            "data": "HS数据内容2"
        }
    ]
}
                    

{
    "error": "Username is required",
    "code": 400,
    "timestamp": "2024-01-15T10:30:00+08:00",
    "success": false
}
                    

POST

get_devices_by_user - 获取用户设备列表

action=get_devices_by_user

获取指定用户的所有设备列表。

请求参数

参数名	类型	必需	描述
action	string	是	操作类型，固定为"get_devices_by_user"
username	string	是	用户名
password	string	是	密码

响应示例

成功响应

错误响应

{
    "success": true,
    "devices": [
        "device001",
        "device002",
        "device003"
    ]
}
                    

{
    "error": "Username and password are required",
    "code": 400,
    "timestamp": "2024-01-15T10:30:00+08:00",
    "success": false
}
                    

POST

get_all_hs_data - 获取所有HS数据

action=get_all_hs_data

获取系统中所有HS数据。

请求参数

参数名	类型	必需	描述
action	string	是	操作类型，固定为"get_all_hs_data"

响应示例

成功响应

错误响应

{
    "success": true,
    "data": [
        {
            "id": 1,
            "data": "HS数据内容1"
        },
        {
            "id": 2,
            "data": "HS数据内容2"
        }
    ]
}
                    

{
    "error": "Database query execution failed",
    "code": 500,
    "timestamp": "2024-01-15T10:30:00+08:00",
    "success": false,
    "details": {
        "action": "get_all_hs_data",
        "mysql_error": "SQL错误信息"
    }
}
                    

POST

add_hs_data - 添加HS数据

action=add_hs_data

为用户添加新的HS数据。

请求参数

参数名	类型	必需	描述
action	string	是	操作类型，固定为"add_hs_data"
username	string	是	用户名