IOTServer接口文档

IOTServer接口文档

API

初始点：http://host:port/IOTServer

响应参数 （此参数为默认参数，以下所有响应参数都包含在data中）

字段名	数据类型	默认值	说明
statusCode	int	0	状态码
success	bool	true	是否成功
data	dict	-	数据域

一、登录

终结点： /login

参数

字段名	数据类型	默认值	说明
username	string	-	用户名
password	string	-	用户密码

响应参数

字段名	数据类型	说明
type	int	用户类型(1为用户、2为店员、3为经理)

响应示例

{
    "statusCode": 0,
    "status": "ok",
    "data": {
        "type": 1,
    },
}

二、环境

1.增添环境数据

终结点： /environment/add_data
参数

字段名	数据类型	默认值	说明
temperature	double	-	温度
humidity	double	-	湿度
light	double	-	亮度
peopleStream	int	-	人流量

响应参数
无

2.获取环境数据

终结点： /environment/get_data

参数

字段名	数据类型	默认值	说明
number	int	-	要获取的条数

响应参数

字段名	数据类型	默认值	说明
environment	environment[]	-	环境数组

environment[]参数

字段名	数据类型	默认值	说明
temperature	double	-	温度
humidity	double	-	湿度
light	double	-	亮度
peopleStream	int	-	人流量

响应示例

{
    "statusCode": 0,
    "status": "ok",
    "data": {
        "environment": [
            {
                "temperature ": 20.5,
                "humidity": 40,
                // 此处其他参数省略
            },
            {
                "temperature ": 25.3,
                "humidity": 50,
                // 此处其他参数省略
            },
        ],
    },
}

三、商品

1.增添新商品数据

终结点： /goods/add_data

参数

字段名	数据类型	默认值	说明
id	string	-	商品编号
name	string	-	商品名称
number	int	-	商品数量
price	double	-	商品单价

响应参数
无

2.获取商品数据

终结点： /goods/get_data

参数

无

响应参数

字段名	数据类型	默认值	说明
goods	goods[]	-	商品数组

goods[]参数

字段名	数据类型	默认值	说明
id	string	-	商品号
name	string	-	商品名称
number	int	-	商品数量
price	double	-	商品单价

响应示例

{
    "statusCode": 0,
    "status": "ok",
    "data": {
        "goods": [
            {
                "id": 1,
                "name": "A",
                "number": 5,
                "price": 10.2,
            },
           {
                "id": 2,
                "name": "B",
                "number": 10,
                "price": 5.3 ,
            },
        ],
    },
}

3.增加已有商品数量

终结点： /goods/add_number

参数

字段名	数据类型	默认值	说明
id	string	-	商品号
number	int	-	商品数量

响应参数
无

四、交易记录

1.增添交易记录

终结点： /record/add_data

参数

字段名	数据类型	默认值	说明
user_id	string	-	用户编号（username）
total_price	double	-	交易总价
consumption_details	string	-	交易细节

交易细节格式

“商品名A:商品数目,商品名B,商品数目,”

例子

比如我买了A商品1个，B商品2个
那么交易细节就是：“A:1,B:2,”
注意：商品数量后面一定要有一个逗号，无论该商品是否是最后一个

响应参数
无

2.获取某个用户所有的交易记录

终结点： /record/get_data

参数

字段名	数据类型	默认值	说明
user_id	string	-	用户编号（username）

响应参数

字段名	数据类型	默认值	说明
record	record[]	-	交易记录数组

record[]参数

字段名	数据类型	默认值	说明
id	int	-	交易编号
total_price	double	-	交易总价
consumption_details	string	-	交易细节

响应示例

{
    "statusCode": 0,
    "status": "ok",
    "data": {
    	"record": [
	    	{
		        "id": 1,
		        "total_price": 100,
		        "consumption_details": "A:1,B:2,C:3,"
		    },
            {
		        "id": 2,
		        "total_price": 200,
		        "consumption_details": "A:2,B:3,C:4,"
		    },
   	    ],
    },
}

3.获取所有的交易记录

终结点： /record/get_all_data

参数
无

响应参数

字段名	数据类型	默认值	说明
record	record[]	-	交易记录数组

record[]参数

字段名	数据类型	默认值	说明
id	int	-	交易编号
user_id	string	-	用户编号
total_price	double	-	交易总价
consumption_details	string	-	交易细节

响应示例

{
    "statusCode": 0,
    "status": "ok",	
    "data": {
    	"record": [
	    	{
		        "id": 1,
		        "user_id": "QAQ",
		        "total_price": 100,
		        "consumption_details": "A:1,B:2,C:3,"
		    },
            {
		        "id": 2,
		         "user_id": "TUT",
		        "total_price": 200,
		        "consumption_details": "A:2,B:3,C:4,"
		    },
   	    ],
    },
}

五、系统控制

1.获取系统数据

终结点： /system/get_data

参数
无

响应参数

字段名	数据类型	默认值	说明
system	system{}	-	系统控制字典

system{}参数

字段名	数据类型	默认值	说明
fan_status	int	-	风扇状态
LED_status	int	-	LED灯状态
door_status	int	-	门状态
humidity_max	double	-	湿度阈值
light_max	double	-	亮度阈值

2.控制系统变量

终结点： /system/set_data

参数

字段名	数据类型	默认值	说明
fan_status	int	-	风扇状态
LED_status	int	-	LED灯状态
door_status	int	-	门状态
humidity_max	double	-	湿度阈值
light_max	double	-	亮度阈值

响应参数

无