版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
停车场API接口目录目录1.
目的和用处52.
通信协议53.
API接口53.1.
用户登录53.1.1.
功能说明53.1.2.
接口定义53.1.3.
恳求参数例如63.1.4.
响应结果例如63.2.
获取用户信息63.2.1.
功能说明63.2.2.
接口定义63.2.3.
恳求参数例如73.2.4.
响应结果例如73.3.
刷新用户状态73.3.1.
功能说明73.3.2.
接口定义83.3.3.
恳求参数例如83.3.4.
响应结果例如83.4.
修改密码93.4.1.
功能说明93.4.2.
接口定义93.4.3.
恳求参数例如93.4.4.
响应结果例如93.5.
获取停车场103.5.1.
功能说明103.5.2.
接口定义103.5.3.
恳求参数例如103.5.4.
响应结果例如113.6.
获取岗亭列表113.6.1.
功能说明113.6.2.
接口定义113.6.3.
恳求参数例如123.6.4.
响应结果例如123.7.
获取车道133.7.1.
功能说明133.7.2.
接口定义133.7.3.
恳求参数例如143.7.4.
响应结果例如143.8.
计费接口153.8.1.
功能说明153.8.2.
接口定义153.8.3.
恳求参数例如163.8.4.
响应结果例如163.9.
保存入场信息173.9.1.
功能说明173.9.2.
接口定义173.9.3.
恳求参数例如173.9.4.
响应结果例如183.10.
获取在场车辆183.10.1.
功能说明183.10.2.
接口定义183.10.3.
恳求参数例如193.10.4.
响应结果例如193.11.
保存出场信息203.11.1.
功能说明203.11.2.
接口定义203.11.3.
恳求参数例如213.11.4.
响应结果例如213.12.
保存支付订单213.12.1.
功能说明213.12.2.
接口定义213.12.3.
恳求参数例如223.12.4.
响应结果例如223.13.
上传图片223.13.L
功能说明223.13.2.
接口定义223.13.3.
恳求参数例如223.13.4.
响应结果例如233.14.
获取参数233.14.1.
功能说明233.14.2.
接口定义233.14.3.
恳求参数例如233.14.4.
响应结果例如243.15.
获取数据字典243.15.1.
功能说明243.15.2.
接口定义243.15.3.
恳求参数例如253.15.4.
响应结果例如254.
MQ接口264.1.
通行数据实时上传264.1.1.
功能说明264.1.2.
接口定义264.1.3.
恳求参数例如271.
目的和用处2.
通信协议接口采用协议,支持GET或POST恳求方式
(详细接口参见接口定义),恳求头需要包含编码描绘:
Content-Type:application/_一form-
urlencoded;charset=utf-8,POST恳求时内容例如如下:--
---header-----POST接口地址/I.1Content-
Type:application/--form-urlencoded;charset=utf-8
---body--------
merchant_no=9827c6b5c6d94485b912b6e90c92a7aetime_st=20
0328172022sign=A3DE1813F4DDBADFC18555E18A2E579
data=%7B%22token%22%3A%22d970cff4-3811-438b-ba90-
50503510345b%22%7D3.
API接口3.1.
用户登录3.1.1.
功能说明该接口用于用户登录使用,通过该接口获取到
用户token。该token用于标识用户,后续接口需要用户信息
的接口需将该token作为入参使用。
3.1.2.
接口定义URL/vl/sys/user/login恳求方法POST恳
求参数参数名称是否必须类型描绘code必须String
用户帐号pwd必须String密码(MD5加密)返回结果参
数名称是否必须类型描绘success必须Bool成功状态
msg必须String失败原因描dataStringtoken
3.1.3.
恳求参数例如{“code":"admin"
“pwd”:“eOOcf25ad42683b3df678c61f42c6bda”}3.1.4.
响应结果例如{"success":true,“msg”:
“登录成功”,“data”:“e5b903fl-6674-46c9-9e00-
5acd27albl2e”)3.2.
获取用户信息3.2.1.
功能说明该接口用于用户信息,需要用户登录调用。
3.2.2.
接口定义URL/vl/sys/user/resetPwd恳求方法POST
恳求参数参数名称是否必须类型描绘sp_sessionid必须
Stringtoken(cookie)返回结果参数名称是否必须
类型描绘successs必须Bool成功状态msg必须
String失败原因描dataString返回用户信息3.2.3.
恳求参数例如{"sp_sessionid”:“e5b903fl-
6674-46c9-9e00-5acd27albl2e,?}cookie3.2.4.
响应结果例如{“data":{“uid”:
^e5b903fl-6674-46c9-9e00-5acd27albl2e,,,
“created“:“20_-09-0614:03:27.404”,
“updated":“20_-09-0614:18:12.822”,
“usejid”:“397e2875-0399-4f90-ba04-177993418b3a”,
“user_code":“admin",“username”:”系统管
理员”,“role_id":u658aeldb-55ba-42a7-a897-
5cca7a79ee7b",“usejtype":“9”},
"msg":“注销成功","success":true}3.3.
刷新用户状态3.3.1.
功能说明该接口用于用户信息更新,每隔90秒更新一
次。
3.3.2.
接口定义URL/vl/sys/user/keepAlive恳求方法POST
恳求参数参数名称是否必须类型描绘sp_sessionid必须
Stringtoken(cookie)返回结果参数名称是否必须
类型描绘successs必须Bool成功状态msg必须
String失败原因描3.3.3.
恳求参数例如{"sp_sessionid":“e5b903fl-
6674-46c9-9e00-5acd27albl2ev}cookie3.3.4.
响应结果例如{“data":{“uid”:
^e5b903fl-6674-46c9-9e00-5acd27albl2ev,
“created":u20__-09-0614:03:27,404,,,
“updated”:“20_-09-0614:18:12.822”,
“user_id”:^397e2875-0399-4f90-ba04-177993418b3av,
“user_code":“admin","username”:”系统管
理员”,“role_id":u658aeldb-55ba-42a7-a897-
5cca7a79ee7b",“usejtype":“9”},
"msg":“注销成功","success":true}3.4.
修改密码3.4.1.
功能说明该接口用于用户登录使用,通过该接口获取到
用户token。该token用于标识用户,后续接口需要用户信息
的接口需将该token作为入参使用。
3.4.2.
接口定义URL/vl/sys/user/resetPwd恳求方法POST
恳求参数参数名称是否必须类型描绘uid必须String
帐号oldpwd必须String旧密码newpwd必须String新
密码返回结果参数名称是否必须类型描绘success必须
Bool成功状态msg必须String失败原因描dataString
帐号3.4.3.
恳求参数例如{"newpwd”:
“21232f297a57a5a743894a0e4a801fc3”,“oldpwd”:
u21232f297a57a5a743894a0e4a801fc3^,“uid”:
u397e2875-0399-4f90-ba04-177993418b3an}3.4.4.
响应结果例如{“data”:u397e2875-0399-
4f90-ba04-177993418b3a",“msg”:“重置密码成
功",“success”:true}3.5.
获取停车场3.5.1.
功能说明该接口获取所有停车场信息,需要求用户登录
后使用。
3.5.2.
接口定义U此/vl/info/parking恳求方法GET恳求参
数参数名称是否必须类型描绘sp_sessionid必须
Token(cookie)返回结果参数名称是否必须类型描绘
successs必须Bool成功状态msg必须String失败原因
描dataStringtoken3.5.3.
恳求参数例如{}3.5.4.
响应结果例如{“success":true,
“total":1,“data”:[{“code”:
“1”,“created":“20_-07-2817:49:24.337”,
“name”:“测试车场”,"status”:“0”,
“uid”:“ebb745fl-ab2b-48ec-9d9d-54914fd5dd6b”,
“updated”:“20__-07-2817:49:24.337”}]
3.6.
获取岗亭列表3.6.1.
功能说明该接口获取所有停车场信息,需要求用户登录
后使用。
3.6.2.
接口定义URL/vl/info/sentry/tree恳求方法GET恳
求参数参数名称是否必须类型描绘sp_sessionid必须
Token(cookie)返回结果参数名称是否必须类型描绘
successs必须Bool成功状态msg必须String失败原因
描dataStringtoken3.6.3.
恳求参数例如{}3.6.4.
响应结果例如{“data”:
[{“children”[{“code":“1”
“name”:“1号岗亭”,“uid”:ua370f62f-30ae-
4742-bc89-54a22(173b419”},{“code”:
“2”,“name”:“2号岗亭”,“uid”:
"954e6604-8352-4f52-9d1c-2dbb0a09c461”}],
“code”:“1”,“name”:“测试车场
type“:"parking”,“uid":^ebb745fl-ab2b-
48ec-9d9d-54914fd5dd6b”},
{"children":[{“code”:“”,
"name":"岗亭","uid”:ude5ebldc-3834-40e8-
a7ac-41el23ea4829”}],“code”:“2”,
“name”:"2号车库”,“type”:“parking”,
“uid”:^0d955fe0-7fla-442a-99a2-
8428904dc970'}],“msg”:,
“success":true}3.7.
获取车道3.7.1.
功能说明该接口获取当前岗亭的所有车道信息,需要求
用户登录后使用。
3.7.2.
接口定义URL/vl/info/lane/list恳求方法GET恳求
参数参数名称是否必须类型描绘sentry_id必须String
岗亭ID返回结果参数名称是否必须类型描绘
successs必须Bool成功状态msg必须String失败原因
描dataStringtokenfactoryString摄像机厂家1:VZ
2:II9:RTSPvideo.sortString视频窗口排序name
String车道名称gate_modeString道闸类型(单闸,双
闸)3.7.3.
恳求参数例如{“sentry_id”:“168bf849-b8a2-
4de5-bc57-92de75a97f60”}3.7.4.
响应结果例如{“data”:[{“code”:
“",“created”:“20_-09-0615:27:48.887”,
“e_tended":"“,“factory”:“2”,
“gatejnode”:“0”,“ip”:“192.168.5.172”,
“name”:“出口”,uparent_id":"168bf849-b8a2-
4de5-bc57-92de75a97f60",“park_idv:uebb745fl
ab2b-48ec-9d9d-54914fd5dd6b",“password”:
“123456”,“port”:“9001","power":
“11111”,“sn”:“16030000alba",“status”:
“0”,“type”:“0”,“uid”:“0c3992bb-
bd16-49ca-b622-bf852106664d”,“updated":“20__-
09-0615:27:48.887v,“usejname“:"admin”,
“video_sort":“0"},{“code":""
“created":“20_-09-0615:27:49.016”,
"e_tended":,"factory":"1”,“ip”:
“192.168.1.173”,“name”:“入口”,
“parent_id":"168bf849-b8a2-4de5-bc57-
92de75a97f60","park_id":4<ebb745fl-ab2b-48ec-
9d9d-54914fd5dd6b”,“pass_word":“admin”,
“port”:“9001”,“power”:“11111”,“sn”:
“6e4073861c726fbl",“status”:“0”,
“type”:“0”,“uid”:^1646bbd5-3763-4fe0-
bf64-60If2c677c33,,,“updated":“20_-09-06
15:27:49.016",“user_name”:“admin”,
“videosort":"0"}],“msg":"",
“success”:true}3.8.
计费接口3.8.1.
功能说明该接口计算停车的费用,需要求用户登录后使
用。停车优惠券暂时未考虑3.8.2.
接口定义URL/vl/info/charge/charge恳求方法GET
恳求参数参数名称是否必须类型描绘time_start必须
String开场时间time_end必须String结算时间park_id
必须String停车场IDmodel必须String车型plate_no
必须String车牌号返回结果参数名称是否必须类型描
绘successs必须Bool成功状态msg必须String失败
原因描dataStringtokenfee必须float费用
minuteString必须String停车时长3.8.3.
恳求参数例如:"20―-09-06
12:00:01”,“time_end”:“20_-09-0614:00:01”,
“parkid”:“ebb745fl-ab2b-48ec-9d9d-54914fd5dd6b”,
"model":"1","plate_no":"闽A23456"
3.8.4.
响应结果例如{“data":{“fee”:6,
"items":[{“type”:“首段”,
“money”:5,“time_start”:“20_-09-0612:00”,
“time_end”:“20_-09-0613:00",“remark”:
“白天5.00元/60分钟”),:“type”:“二
段”,“money":1,“time_start":"20―-09-
0613:00",utime_end":"20_-09-0614:00”,
uremark":"白天L00元/60分钟”}],
uitems_totalv:2,“minute”:120,
“minuteString":“2时0分”,uvalidminute":
120),“msg”:“ok”,“success”:true)
3.9.
保存入场信息3.9.1.
功能说明该接口保存入场信息,需要求用户登录后使
用。
3.9.2.
接口定义URL/vl/busi/records/save/in恳求方法
GET恳求参数参数名称是否必须类型描绘io.time必须
String入场时间channelid必须通道IDplate_no必须
车牌号码color必须车牌颜色card_no必须卡号
pic_big必须大图片途径pic_small可选小图片途径
reason可选放行原因编号返回结果参数名称是否必须
类型描绘successs必须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","cardno”:
,“pic_big":u/20_-09/20_-09-
06/6e4073861c726fbl/11203.jpgv,"pic_small”:
,“reason":"01”}3.9.4.
响应结果例如{“msg”:“保存成功”,
“success":true)3.10.
获取在场车辆3.10.1.
功能说明该接口获取在场的车辆信息,需要求用户登录
后使用。
3.10.2.
接口定义URL/vl/busi/records/entry恳求方法GET
恳求参数参数名称是否必须类型描绘time_start可选
String开场时间time_end可选String完毕时间plate_no
可选String车牌号码tolerant可选String容错字符数
(1:90%.2:75%、4:50%6:25%)返回结果参数名称
是否必须类型描绘success必须Bool成功状态msg必须
String失败原因描dataplate_no车号io_time
入场时间uid入场IDcar_model车型card_type
车辆类别pic_big大图pic_small小图3.10.3.
恳求参数例如{}3.10.4.
响应结果例如{“success":true,
“total":1,“data":[{“carmodel”:
“1”,"card_type":“0”,“channel_id”:
1646bbd5-3763-4fe0-bf64-601f2c677c33v,“color”:
,“iojime":“20_-09-1016:39:13”,
“pic_big":a/pics/20_0910/76933.jpg”,
“pic_small":“/pics/20—0910/small/76933.jpgv,
“plate_no":"闽A23456","uid":“68c8f64f-
6cd6-43be-8f24-3d9fdle60b6a'}]}3.11.
保存出场信息3.11.1.
功能说明该接口同时保存出场和支付订单,需要求用户
登录后使用。
3.11.2.
接口定义URL/vl/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放行原因编号ref_id必须String入场IDfee必
须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/vl/busi/payorder/save恳求方法GET
恳求参数参数名称是否必须类型描绘返回结果参
数名称是否必须类型描绘successs必须Bool成功状态
msg必须String失败原因描dataStringtoken
3.12.3.
恳求参数例如{"sentryid”:“168bf849-b8a2-
4de5-bc57-92de75a97f60”}3.12.4.
响应结果例如3.13.
上传图片3.13.1.
功能说明该接口上传图片到效劳器。
3.13.2.
接口定义URL/vl/busi/records/pic/save/:m/:d/:lane
/:filename--〔大图)
/vl/busi/records/pic/save/:m/:d/:lane/small/:filename
~1小图)
/vl/busi/records/pic/save/:m/:d/:lane/snap/:filename
一抓拍图恳求方法POST恳求参数参数名称是否必须类型
描绘图片必须流文件返回结果参数名称是否必须
类型描绘successs必须Bool成功状态msg必须
String失败原因描dataStringtoken3.13.3.
恳求参数例如{"sentry_id":u168bf849-b8a2-
4de5-bc57-92de75a97f60v}3.13.4.
响应结果例如{“msg”:“保存成功”,
“success”:true}3.14.
获取参数3.14.1.
功能说明该接口获取系统参数,需要求用户登录后使
用。
3.14.2.
接口定义URL/vl/sys/conf/all恳求方法GET恳求参
数参数名称是否必须类型描绘返回结果参数名称
是否必须类型描绘successs必须Bool成功状态msg必
须String失败原因描dataStringcode参数编号
value参数值3.14.3.
恳求参数例如{}3.14.4.
响应结果例如{“data":[{"attr":
“code":"P0”,"e_tended”:
"value":“粤S”},:、“attr":
“code”:“P0215”,“e_tended":,
“value":'T],“success":true,
“total":2}3.15.
获取数据字典3.15.1.
功能说明该接口获取系统数据字典数据,免登录。
3.15.2.
接口定义URL/vl/sys/dict/list恳求方法GET恳求
参数参数名称是否必须类型描绘groupcode必须String
类别编码返回结果参数名称是否必须类型描绘
successs必须Bool成功状态msg必须String失败原因
描dataStringcodeString编码valueString名
称3.15.3.
恳求参数例如{}3.15.4.
响应结果例如{“data”:[“code
“1",“e_tended":,Ugroup_codev:
“S002”,“remarks":,“sort”:“1”,
“status”:“0”,“uid”:u4b849454-64f0-498c-
9edl-44eell24da2bv,"value”:“小型车”),
[code:2,e_tended:,
agroup_code:“S002","remarks":,
“sort”:“2”,“status”:“0”,“uid”:
u52d90a6a-a48f-43f0-87ea-13719f7273b8v,“value”:
“大型车,,],“success":true,
“total":0}3.16.
抓拍记录3.16.1.
功能说明该接口提交人工开闸记录。
3.16.2.
接口定义URL/vl/busi/snap恳求方法POST恳求参数
参数名称是否必须类型描绘io_time必须String出入时
间direction必须Int方向:0:入1:出type必须Int
类型:0:电脑开闸1:遥控开闸pic_big必须String全景
照片途径park_id必须String停车场IDchannel_id必须
String通道opejcode必须String操作员返回结果参数
名称是否必须类型描绘successs必须Bool成功状态
msg必须String失败原因描dataString3.16.3.
恳求参数例如{}3.16.4.
响应结果例如{“msg”:“保存成功”,
“success":true)3.17.
上班确认3.17.1.
功能说明上班时调用该接口,交班后更新时间。
3.17.2.
接口定义URL/v1/busi/account/work恳求方法GET
恳求参数参数名称是否必须类型描绘usesid必须用
户编号work_start必须上班时间返回结果参数名称
是否必须类型描绘successs必须Bool成功状态msg必
须String失败原因描dataStringwork_start
String上班时间3.17.3.
恳
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 小学二年级下册艺术题创造知识点练习试卷
- 2026年gmp取样测试题及答案
- 2026年智慧停车信息测试题及答案
- 2026年亿达招聘测试题及答案
- 2026年互动考眼力测试题及答案
- 2026年自控辅助测试题及答案
- 2026年销售综合职业测试题及答案
- 2026年量化投资知识 测试题及答案
- 2026年防范性侵害测试题及答案
- 2026年小学空间思维测试题及答案
- 中国热带农业科学院院属单位2026年第一批公开招聘工作人员备考题库及一套参考答案详解
- 2026年石油工程师钻井技术方向面试要点与答案解析
- 2026年南昌市政公用集团公开招聘工作人员备考题库及参考答案详解
- 中国临床肿瘤学会(CSCO)食管癌诊疗指南2025
- 启示录概论课件
- 2025年郑州金水区招聘社区工作者200名(公共基础知识)测试题附答案解析
- GB/T 18324-2025滑动轴承铜合金轴套尺寸和公差
- 220kV输变电工程建议书
- 建筑设计立意构思
- 2025年南京市中考物理试卷(含答案及解析)
- 2024广东省湛江市技师学院工作人员招聘考试试题及答案
评论
0/150
提交评论