新停车场API接口V1.1V接口

第页共页停车场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.1.功能说明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恳求时内容例如如下:headerPOST接口地址/1.1Content-Type:application/_--form-urlencoded;charset=utf-8bodymerchant_no=9827c6b5c6d94485b912b6e90c92a7aetime_st=20__0328172022sign=A3DE1813F4DDBADFC18555E18A2E579data=%7B%22token%22%3A%22d970cff4-3811-438b-ba90-50503510345b%22%7D3.API接口3.1.用户登录3.1.1.功能说明该接口用于用户登录使用，通过该接口获取到用户token。该token用于标识用户，后续接口需要用户信息的接口需将该token作为入参使用。3.1.2.接口定义URL/v1/sys/user/login恳求方法POST恳求参数参数名称是否必须类型描绘code必须String用户帐号pwd必须String密码〔MD5加密〕返回结果参数名称是否必须类型描绘success必须Bool成功状态msg必须String失败原因描dataStringtoken3.1.3.恳求参数例如{“code”:“admin”“pwd”:“e00cf25ad42683b3df678c61f42c6bda”}3.1.4.响应结果例如{“success”:true,“msg”:“登录成功”,“​data”:“e5b903f1-6674-46c9-9e00-5acd27a1b12e”}3.2.获取用户信息3.2.1.功能说明该接口用于用户信息，需要用户登录调用。3.2.2.接口定义URL/v1/sys/user/resetPwd恳求方法POST恳求参数参数名称是否必须类型描绘sp_sessionid必须Stringtoken〔cookie〕返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描dataString返回用户信息3.2.3.恳求参数例如{“sp_sessionid”:“e5b903f1-6674-46c9-9e00-5acd27a1b12e”}cookie3.2.4.响应结果例如{“data”:{“uid”:“e5b903f1-6674-46c9-9e00-5acd27a1b12e”,“created”:“20__-09-0614:03:27.404”,“updated”:“20__-09-0614: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”:“注销成功”,“success”:true}3.3.刷新用户状态3.3.1.功能说明该接口用于用户信息更新，每隔90秒更新一次。3.3.2.接口定义URL/v1/sys/user/keepAlive恳求方法POST恳求参数参数名称是否必须类型描绘sp_sessionid必须Stringtoken〔cookie〕返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描3.3.3.恳求参数例如{“sp_sessionid”:“e5b903f1-6674-46c9-9e00-5acd27a1b12e”}cookie3.3.4.响应结果例如{“data”:{“uid”:“e5b903f1-6674-46c9-9e00-5acd27a1b12e”,“created”:“20__-09-0614:03:27.404”,“updated”:“20__-09-0614: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”:“注销成功”,“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成功状态msg必须String失败原因描dataString帐号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.1.功能说明该接口获取所有停车场信息，需要求用户登录后使用。3.5.2.接口定义URL/v1/info/parking恳求方法GET恳求参数参数名称是否必须类型描绘sp_sessionid必须Token(cookie)返回结果参数名称是否必须类型描绘successｓ必须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”:“ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b”,“updated”:“20__-07-2817:49:24.337”}]}3.6.获取岗亭列表3.6.1.功能说明该接口获取所有停车场信息，需要求用户登录后使用。3.6.2.接口定义URL/v1/info/sentry/tree恳求方法GET恳求参数参数名称是否必须类型描绘sp_sessionid必须Token(cookie)返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描dataStringtoken3.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”,“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.功能说明该接口获取当前岗亭的所有车道信息，需要求用户登录后使用。3.7.2.接口定义URL/v1/info/lane/list恳求方法GET恳求参数参数名称是否必须类型描绘sentry_id必须String岗亭ID返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描dataStringtokenfactoryString摄像机厂家1:VZ2:H_9:RTSPvideo_sortString视频窗口排序nameString车道名称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”,“gate_mode”:“0”,“ip”:“192.168.5.172”,“name”:“出口”,“parent_id”:“168bf849-b8a2-4de5-bc57-92de75a97f60”,“park_id”:“ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b”,“pass_word”:“123456”,“port”:“9001”,“power”:“11111”,“sn”:“16030000a1ba”,“status”:“0”,“type”:“0”,“uid”:“0c3992bb-bd16-49ca-b622-bf852106664d”,“updated”:“20__-09-0615:27:48.887”,“user_name”:“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”:“ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b”,“pass_word”:“admin”,“port”:“9001”,“power”:“11111”,“sn”:“6e4073861c726fb1”,“status”:“0”,“type”:“0”,“uid”:“1646bbd5-3763-4fe0-bf64-601f2c677c33”,“updated”:“20__-09-0615: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结算时间park_id必须String停车场IDmodel必须String车型plate_no必须String车牌号返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描dataStringtokenfee必须float费用minuteString必须String停车时长3.8.3.恳求参数例如“time_start”:“20__-09-0612:00:01”,“time_end”:“20__-09-0614:00:01”,“park_id”:“ebb745f1-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”,“time_end”:“20__-09-0614: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必须通道IDplate_no必须车牌号码color必须车牌颜色card_no必须卡号pic_big必须大图片途径pic_small可选小图片途径reason可选放行原因编号返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描3.9.3.恳求参数例如{“io_time”:“20__-09-0612:01:09”,“plate_no”:“粤SC8L28”,“channel_id”:“1646bbd5-3763-4fe0-bf64-601f2c677c33”,“color”:“1”,“card_no”:“”,“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可选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”:[{“car_model”:“1”,“card_type”:“0”,“channel_id”:“1646bbd5-3763-4fe0-bf64-601f2c677c33”,“color”:“”,“io_time”:“20__-09-1016: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.保存出场信息3.11.1.功能说明该接口同时保存出场和支付订单，需要求用户登录后使用。3.11.2.接口定义URL/v1/busi/records/save/out恳求方法GET恳求参数参数名称是否必须类型描绘io_time必须String入场时间channel_id必须String通道IDplate_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/v1/busi/payorder/save恳求方法GET恳求参数参数名称是否必须类型描绘返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描dataStringtoken3.12.3.恳求参数例如{“sentry_id”:“168bf849-b8a2-4de5-bc57-92de75a97f60”}3.12.4.响应结果例如3.13.上传图片3.13.1.功能说明该接口上传图片到效劳器。3.13.2.接口定义URL/v1/busi/records/pic/save/:m/:d/:lane/:filename--〔大图〕/v1/busi/records/pic/save/:m/:d/:lane/small/:filename--〔小图〕/v1/busi/records/pic/save/:m/:d/:lane/snap/:filename--抓拍图恳求方法POST恳求参数参数名称是否必须类型描绘图片必须流文件返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描dataStringtoken3.13.3.恳求参数例如{“sentry_id”:“168bf849-b8a2-4de5-bc57-92de75a97f60”}3.13.4.响应结果例如{“msg”:“保存成功”,“success”:true}3.14.获取参数3.14.1.功能说明该接口获取系统参数，需要求用户登录后使用。3.14.2.接口定义URL/v1/sys/conf/all恳求方法GET恳求参数参数名称是否必须类型描绘返回结果参数名称是否必须类型描绘successｓ必须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”:“1”}],“success”:true,“total”:2}3.15.获取数据字典3.15.1.功能说明该接口获取系统数据字典数据，免登录。3.15.2.接口定义URL/v1/sys/dict/list恳求方法GET恳求参数参数名称是否必须类型描绘groupcode必须String类别编码返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描dataStringcodeString编码valueString名称3.15.3.恳求参数例如{}3.15.4.响应结果例如{“data”:[{“code”:“1”,“e_tended”:“”,“group_code”:“S002”,“remarks”:“”,“sort”:“1”,“status”:“0”,“uid”:“4b849454-64f0-498c-9ed1-44ee1124da2b”,“value”:“小型车”},{“code”:“2”,“e_tended”:“”,“group_code”:“S002”,“remarks”:“”,“sort”:“2”,“status”:“0”,“uid”:“52d90a6a-a48f-43f0-87ea-13719f7273b8”,“value”:“大型车”}],“success”:true,“total”:0}3.16.抓拍记录3.16.1.功能说明该接口提交人工开闸记录。3.16.2.接口定义URL/v1/busi/snap恳求方法POST恳求参数参数名称是否必须类型描绘io_time必须String出入时间direction必须Int方向：0：入1：出type必须Int类型：0：电脑开闸1:遥控开闸pic_big必须String全景照片途径park_id必须String停车场IDchannel_id必须String通道oper_code必须String操作员返回结果参数名称是否必须类型描绘successｓ必须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恳求参数参数名称是否必须类型描绘uses_id必须用户编号work_start必须上班时间返回结果参数名称是否必须类型描绘successｓ必须Bool成功状态msg必须String失败原因描dataStringwork_startString上班时间3.17.3.恳求参数例如