chinosk6 / ycm-api

简易的查车车API, 支持自定义车牌类型

ycm-api

• 简易的查车车API

API说明

• 公共API: https://ycm.chinosk6.cn
• 若需要使用, 请直接联系我, 或者发送邮件到[e-mail]
• car_type默认支持arc. 若需要添加其它类型车牌支持, 请使用 添加车车类型 自行添加

查车车

• 接口: /get_car
• 需要权限: 1

参数	类型	说明	可选的
token	string	身份验证	×
car_type	string	车车类型	×
time_limit	int	获取x秒内的车, 最多获取1200秒	×

• 返回值

参数	类型	说明
code	int	状态码
message	string	说明
car_type	string	车牌类型全名
cars	array[car]	车车信息数组

添加车车

• 接口: /add_car
• 需要权限: 1

参数	类型	说明	可选的
token	string	身份验证	×
car_type	string	车车类型	×
room_id	string	房间id	×
description	string	房间描述	×
data_from	string	数据来源(平台, bot等)	×
creator_id	string	创建者id	×
more_info	string	更多信息(暂时没用)	√

• 返回值

参数	类型	说明
code	int	状态码
message	string	说明
id	int	该车的内部id, 非车牌号
car_type	string	车牌类型全名
car	car	当code为0时, 正常发车, 此参数不存在 当code为1004时, 重复发车, 此项返回重复车信息

添加车车类型

• 接口: /add_car_table
• 添加后就可以在查车/加车时使用对应的car_type进行操作
• 需要权限: 2

参数	类型	说明	可选的
token	string	身份验证	×
car_name	string	车车类型(全称)	×
car_alias	array[string]	车车别称	×

• 返回值

参数	类型	说明
code	int	状态码
message	string	说明

添加token

• 接口: /add_token
• 需要权限: 3

参数	类型	说明	可选的
token	string	自己的token	×
userid	string	用户id	×
username	string	用户名	√
description	string	简单描述	√
permission	int	此token的权限等级 可填入1/2/3 数字越大, 权限越高	×

更新token

• 接口: /update_token
• 需要权限: 1

参数	类型	说明	可选的
token	string	自己的token	×
token_set	string	设置的token, 若为空, 则生成随机token	√

• 返回值

参数	类型	说明
code	int	状态码
message	string	说明
token	string	更新后的token

返回数据说明

car

参数	类型	说明
id	int	该车内部ID
room_id	string	该车车牌号(房间号)
description	string	车辆简介
data_from	string	数据来源
creator_id	string	创建者ID
more_info	string	更多信息
add_time	int	车牌添加时间戳

---

状态码说明

状态码	说明
0	请求正常处理/有车
403	没有权限
404	没有车
500	服务器内部错误
1001	参数输入错误
1002	参数类型错误
1003	缺少必要参数
1004	有车啦(重复发车) 重复发车的判定时间为120秒 一般出现在多bot群, 重复触发指令 也有可能是有人多发了一次
1005	同一用户在120秒内发了两次以上的车, 请求被拒绝

自行部署

• 确保您拥有python3环境
• 需要以下包: pip install -r requirements.txt

Flask~=2.0.1

• 运行:

  • 编辑app.py内的ip和端口
  • python app.py

• 说明: 自行部署之后有一个权限为3的初始token: admin, 请使用更新token接口自行更改, 或者直接编辑数据库。