新停车场API接口V11V接口.docx

1、新停车场API接口V11V接口停车场API接口 目录 目录 1.目的和用处 5 2.通信协议 5 3.API接口 5 3.1.用户登录 5 3.1.1.功能说明 5 3.1.2.接口定义 5 3.1.3.恳求参数例如 6 3.1.4.响应结果例如 6 3.2.获取用户信息 6 3.2.1.功能说明 6 3.2.2.接口定义 6 3.2.3.恳求参数例如 7 3.2.4.响应结果例如 7 3.3.刷新用户状态 7 3.3.1.功能说明 7 3.3.2.接口定义 8 3.3.3.恳求参数例如 8 3.3.4.响应结果例如 8 3.4.修改密码 9 3.4.1.功能说明 9 3.4.2.接口定义 9

2、 3.4.3.恳求参数例如 9 3.4.4.响应结果例如 9 3.5.获取停车场 10 3.5.1.功能说明 10 3.5.2.接口定义 10 3.5.3.恳求参数例如 10 3.5.4.响应结果例如 11 3.6.获取岗亭列表 11 3.6.1.功能说明 11 3.6.2.接口定义 11 3.6.3.恳求参数例如 12 3.6.4.响应结果例如 12 3.7.获取车道 13 3.7.1.功能说明 13 3.7.2.接口定义 13 3.7.3.恳求参数例如 14 3.7.4.响应结果例如 14 3.8.计费接口 15 3.8.1.功能说明 15 3.8.2.接口定义 15 3.8.3.恳求参数

3、例如 16 3.8.4.响应结果例如 16 3.9.保存入场信息 17 3.9.1.功能说明 17 3.9.2.接口定义 17 3.9.3.恳求参数例如 17 3.9.4.响应结果例如 18 3.10.获取在场车辆 18 3.10.1.功能说明 18 3.10.2.接口定义 18 3.10.3.恳求参数例如 19 3.10.4.响应结果例如 19 3.11.保存出场信息 20 3.11.1.功能说明 20 3.11.2.接口定义 20 3.11.3.恳求参数例如 21 3.11.4.响应结果例如 21 3.12.保存支付订单 21 3.12.1.功能说明 21 3.12.2.接口定义 21 3

4、.12.3.恳求参数例如 22 3.12.4.响应结果例如 22 3.13.上传图片 22 3.13.1.功能说明 22 3.13.2.接口定义 22 3.13.3.恳求参数例如 22 3.13.4.响应结果例如 23 3.14.获取参数 23 3.14.1.功能说明 23 3.14.2.接口定义 23 3.14.3.恳求参数例如 23 3.14.4.响应结果例如 24 3.15.获取数据字典 24 3.15.1.功能说明 24 3.15.2.接口定义 24 3.15.3.恳求参数例如 25 3.15.4.响应结果例如 25 4.MQ接口 26 4.1.通行数据实时上传 26 4.1.1.功能

5、说明 26 4.1.2.接口定义 26 4.1.3.恳求参数例如 27 1.目的和用处 2.通信协议 接口采用 协议，支持 GET 或 POST 恳求方式详细接口参见接口定义， 恳求头需要包含编码描绘： Content-Type:application/_-form-urlencoded;charset=utf-8， POST 恳求时内容例如如下: -header- POST 接口地址 /1.1 Content-Type:application/_-form-urlencoded;charset=utf-8 -body- merchant_no=9827c6b5c6d94485b912b6e9

6、0c92a7aetime_st=20_0328172022sign=A3DE1813F4DDBADFC18555E18A2E579 data=%7B%22token%22%3A%22d970cff4-3811-438b-ba90-50503510345b%22%7D 3.API接口 3.1.用户登录 3.1.1.功能说明 该接口用于用户登录使用，通过该接口获取到用户token。该 token用于标识用户，后续接口需要用户信息的接口需将该token作为入参使用。 3.1.2.接口定义 URL /v1/sys/user/login 恳求方法 POST 恳求参数 参数名称 是否必须 类型 描绘 co

7、de 必须 String 用户帐号 pwd 必须 String 密码MD5加密 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool 成功状态 msg 必须 String 失败原因描 data String token 3.1.3.恳求参数例如 “code”: “admin” “pwd”: “e00cf25ad42683b3df678c61f42c6bda” 3.1.4.响应结果例如 “success”: true, “msg”: “登录成功”, “data”: “e5b903f1-6674-46c9-9e00-5acd27a1b12e” 3.2.获取用户信息 3.2.1.

8、功能说明 该接口用于用户信息，需要用户登录调用。 3.2.2.接口定义 URL /v1/sys/user/resetPwd 恳求方法 POST 恳求参数 参数名称 是否必须 类型 描绘 sp_sessionid 必须 String tokencookie 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool 成功状态 msg 必须 String 失败原因描 data String 返回用户信息 3.2.3.恳求参数例如 “sp_sessionid”: “e5b903f1-6674-46c9-9e00-5acd27a1b12e” cookie 3.2.4.响应结果例如 “da

9、ta”: “uid”: “e5b903f1-6674-46c9-9e00-5acd27a1b12e”, “created”: “20_-09-06 14:03:27.404”, “updated”: “20_-09-06 14:18:12.822”, “user_id”: “397e2875-0399-4f90-ba04-177993418b3a”, “user_code”: “admin”, “user_name”: “系统管理员”, “role_id”: “658ae1db-55ba-42a7-a897-5cca7a79ee7b”, “user_type”: “9” , “msg”: “注

10、销成功”, “success”: true 3.3.刷新用户状态 3.3.1.功能说明 该接口用于用户信息更新，每隔90秒更新一次。 3.3.2.接口定义 URL /v1/sys/user/keepAlive 恳求方法 POST 恳求参数 参数名称 是否必须 类型 描绘 sp_sessionid 必须 String tokencookie 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool 成功状态 msg 必须 String 失败原因描 3.3.3.恳求参数例如 “sp_sessionid”: “e5b903f1-6674-46c9-9e00-5acd27a1b12e”

11、 cookie 3.3.4.响应结果例如 “data”: “uid”: “e5b903f1-6674-46c9-9e00-5acd27a1b12e”, “created”: “20_-09-06 14:03:27.404”, “updated”: “20_-09-06 14:18:12.822”, “user_id”: “397e2875-0399-4f90-ba04-177993418b3a”, “user_code”: “admin”, “user_name”: “系统管理员”, “role_id”: “658ae1db-55ba-42a7-a897-5cca7a79ee7b”, “use

12、r_type”: “9” , “msg”: “注销成功”, “success”: true 3.4.修改密码 3.4.1.功能说明 该接口用于用户登录使用，通过该接口获取到用户token。该 token用于标识用户，后续接口需要用户信息的接口需将该token作为入参使用。 3.4.2.接口定义 URL /v1/sys/user/resetPwd 恳求方法 POST 恳求参数 参数名称 是否必须 类型 描绘 uid 必须 String 帐号 oldpwd 必须 String 旧密码 newpwd 必须 String 新密码 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool

13、 成功状态 msg 必须 String 失败原因描 data String 帐号 3.4.3.恳求参数例如 “newpwd”: “21232f297a57a5a743894a0e4a801fc3”, “oldpwd”: “21232f297a57a5a743894a0e4a801fc3”, “uid”: “397e2875-0399-4f90-ba04-177993418b3a” 3.4.4.响应结果例如 “data”: “397e2875-0399-4f90-ba04-177993418b3a”, “msg”: “重置密码成功”, “success”: true 3.5.获取停车场 3.5.

14、1.功能说明 该接口获取所有停车场信息，需要求用户登录后使用。 3.5.2.接口定义 URL /v1/info/parking 恳求方法 GET 恳求参数 参数名称 是否必须 类型 描绘 sp_sessionid 必须 Token(cookie) 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool 成功状态 msg 必须 String 失败原因描 data String token 3.5.3.恳求参数例如 3.5.4.响应结果例如 “success”: true, “total”: 1, “data”: “code”: “1”, “created”: “20_-07-2

15、8 17:49:24.337”, “name”: “测试车场”, “status”: “0”, “uid”: “ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b”, “updated”: “20_-07-28 17:49:24.337” 3.6.获取岗亭列表 3.6.1.功能说明 该接口获取所有停车场信息，需要求用户登录后使用。 3.6.2.接口定义 URL /v1/info/sentry/tree 恳求方法 GET 恳求参数 参数名称 是否必须 类型 描绘 sp_sessionid 必须 Token(cookie) 返回结果 参数名称 是否必须 类型 描绘 succe

16、ss 必须 Bool 成功状态 msg 必须 String 失败原因描 data String token 3.6.3.恳求参数例如 3.6.4.响应结果例如 “data”: “children”: “code”: “1”, “name”: “1号岗亭”, “uid”: “a370f62f-30ae-4742-bc89-54a22d73b419” , “code”: “2”, “name”: “2号岗亭”, “uid”: “954e6604-8352-4f52-9d1c-2dbb0a09c461” , “code”: “1”, “name”: “测试车场”, “type”: “parking”

17、, “uid”: “ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b” , “children”: “code”: “”, “name”: “岗亭”, “uid”: “de5eb1dc-3834-40e8-a7ac-41e123ea4829” , “code”: “2”, “name”: “2号车库”, “type”: “parking”, “uid”: “0d955fe0-7f1a-442a-99a2-8428904dc970” , “msg”: “”, “success”: true 3.7.获取车道 3.7.1.功能说明 该接口获取当前岗亭的所有车道信息，需要求用

18、户登录后使用。 3.7.2.接口定义 URL /v1/info/lane/list 恳求方法 GET 恳求参数 参数名称 是否必须 类型 描绘 sentry_id 必须 String 岗亭ID 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool 成功状态 msg 必须 String 失败原因描 data String token factory String 摄像机厂家 1:VZ 2:H_ 9:RTSP video_sort String 视频窗口排序 name String 车道名称 gate_mode String 道闸类型单闸，双闸 3.7.3.恳求参数例如 “se

19、ntry_id”:“168bf849-b8a2-4de5-bc57-92de75a97f60” 3.7.4.响应结果例如 “data”: “code”: “”, “created”: “20_-09-06 15:27:48.887”, “e_tended”: “”, “factory”: “2”, “gate_mode”: “0”, “ip”: “192.168.5.172”, “name”: “出口”, “parent_id”: “168bf849-b8a2-4de5-bc57-92de75a97f60”, “park_id”: “ebb745f1-ab2b-48ec-9d9d-54914f

20、d5dd6b”, “pass_word”: “123456”, “port”: “9001”, “power”: “11111”, “sn”: “16030000a1ba”, “status”: “0”, “type”: “0”, “uid”: “0c3992bb-bd16-49ca-b622-bf852106664d”, “updated”: “20_-09-06 15:27:48.887”, “user_name”: “admin”, “video_sort”: “0” , “code”: “”, “created”: “20_-09-06 15:27:49.016”, “e_tended

21、”: “”, “factory”: “1”, “ip”: “192.168.1.173”, “name”: “入口”, “parent_id”: “168bf849-b8a2-4de5-bc57-92de75a97f60”, “park_id”: “ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b”, “pass_word”: “admin”, “port”: “9001”, “power”: “11111”, “sn”: “6e4073861c726fb1”, “status”: “0”, “type”: “0”, “uid”: “1646bbd5-3763-4fe0

22、-bf64-601f2c677c33”, “updated”: “20_-09-06 15:27:49.016”, “user_name”: “admin”, “video_sort”: “0” , “msg”: “”, “success”: true 3.8.计费接口 3.8.1.功能说明 该接口计算停车的费用，需要求用户登录后使用。停车优惠券暂时未考虑 3.8.2.接口定义 URL /v1/info/charge/charge 恳求方法 GET 恳求参数 参数名称 是否必须 类型 描绘 time_start 必须 String 开场时间 time_end 必须 String 结算时间 pa

23、rk_id 必须 String 停车场ID model 必须 String 车型 plate_no 必须 String 车牌号 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool 成功状态 msg 必须 String 失败原因描 data String token fee 必须 float 费用 minuteString 必须 String 停车时长 3.8.3.恳求参数例如 “time_start”: “20_-09-06 12:00:01”, “time_end”: “20_-09-06 14:00:01”, “park_id”: “ebb745f1-ab2b-48e

24、c-9d9d-54914fd5dd6b”, “model”: “1”, “plate_no”: “闽A23456” 3.8.4.响应结果例如 “data”: “fee”: 6, “items”: “type”: “首段”, “money”: 5, “time_start”: “20_-09-06 12:00”, “time_end”: “20_-09-06 13:00”, “remark”: “白天5.00元/60分钟” , “type”: “二段”, “money”: 1, “time_start”: “20_-09-06 13:00”, “time_end”: “20_-09-06 14:

25、00”, “remark”: “白天1.00元/60分钟” , “items_total”: 2, “minute”: 120, “minuteString”: “2时0分”, “valid_minute”: 120 , “msg”: “ok”, “success”: true 3.9.保存入场信息 3.9.1.功能说明 该接口保存入场信息，需要求用户登录后使用。 3.9.2.接口定义 URL /v1/busi/records/save/in 恳求方法 GET 恳求参数 参数名称 是否必须 类型 描绘 io_time 必须 String 入场时间 channel_id 必须 通道ID plat

26、e_no 必须 车牌号码 color 必须 车牌颜色 card_no 必须 卡号 pic_big 必须 大图片途径 pic_small 可选 小图片途径 reason 可选 放行原因编号 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool 成功状态 msg 必须 String 失败原因描 3.9.3.恳求参数例如 “io_time”: “20_-09-06 12:01:09”, “plate_no”: “粤SC8L28”, “channel_id”: “1646bbd5-3763-4fe0-bf64-601f2c677c33”, “color”: “1”, “card_n

27、o”: “”, “pic_big”: “/20_-09/20_-09-06/6e4073861c726fb1/11203.jpg”, “pic_small”: “”, “reason”:“01” 3.9.4.响应结果例如 “msg”: “保存成功”, “success”: true 3.10.获取在场车辆 3.10.1.功能说明 该接口获取在场的车辆信息，需要求用户登录后使用。 3.10.2.接口定义 URL /v1/busi/records/entry 恳求方法 GET 恳求参数 参数名称 是否必须 类型 描绘 time_start 可选 String 开场时间 time_end 可选 St

28、ring 完毕时间 plate_no 可选 String 车牌号码 tolerant 可选 String 容错字符数(1:90%、2:75% 、4:50% 6:25%) 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool 成功状态 msg 必须 String 失败原因描 data plate_no 车号 io_time 入场时间 uid 入场ID car_model 车型 card_type 车辆类别 pic_big 大图 pic_small 小图 3.10.3.恳求参数例如 3.10.4.响应结果例如 “success”: true, “total”: 1, “data

29、”: “car_model”: “1”, “card_type”: “0”, “channel_id”: “1646bbd5-3763-4fe0-bf64-601f2c677c33”, “color”: “”, “io_time”: “20_-09-10 16:39:13”, “pic_big”: “/pics/20_0910/76933.jpg”, “pic_small”: “/pics/20_0910/small/76933.jpg”, “plate_no”: “闽A23456”, “uid”: “68c8f64f-6cd6-43be-8f24-3d9fd1e60b6a” 3.11.保存出

30、场信息 3.11.1.功能说明 该接口同时保存出场和支付订单，需要求用户登录后使用。 3.11.2.接口定义 URL /v1/busi/records/save/out 恳求方法 GET 恳求参数 参数名称 是否必须 类型 描绘 io_time 必须 String 入场时间 channel_id 必须 String 通道ID plate_no 必须 String 车牌号码 color 必须 String 车牌颜色 card_no 必须 String 卡号 pic_big 必须 String 大图片途径 pic_small 可选 String 小图片途径 reason 可选 String 放行原

31、因编号 ref_id 必须 String 入场ID fee 必须 float 应收金额停车费用 fee_discount 必须 float 优惠金额 fee_real 必须 float 实收金额 pay_mode 必须 int 支付方式：0：现金 pay_channel 必须 int 支付渠道0: 岗亭 pass_type 必须 int 放行方式：0：识别放行 payee_code 必须 String 收款人帐号 uid 选填 String 出场ID 返回结果 参数名称 是否必须 类型 描绘 success 必须 Bool 成功状态 msg 必须 String 失败原因描 3.11.3.恳求参数例如 3.11.4.响应结果例如 “msg”: “保存成功”, “success”: true 3.12.保存支付订单 3.12.1.功能说明 暂时未实现，在保存出场已有实现了。 3.12.2.接口定义 URL /v1/busi/payorder/save 恳求方法 GET 恳求参数 参数名称 是否必须 类型 描绘 返回