接口概览
好停ParkingLink API采用RESTful风格设计,基础URL为https://api.parkinglink.cn,所有接口返回JSON格式数据。API按业务领域分为停车场管理、订单管理、支付管理、统计分析和Webhook事件五大模块,共100+接口。所有接口遵循统一的请求格式、认证方式和错误处理规范。
停车场管理API
获取停车场列表(GET /api/v1/parking/lots):支持按city(城市名称)、keyword(搜索关键词)、status(active或inactive)筛选,page和size为分页参数。响应data.list包含parking_lot_id、name、address、total_spaces、available_spaces、longitude、latitude、business_hours、pricing_rule_id等信息。
获取停车场详情(GET /api/v1/parking/lots/:id):通过parking_lot_id获取单个停车场的完整信息。响应包含基本信息、车位实时状态、计费规则详情、设备列表(相机和道闸信息)、运营统计数据等。该接口需要认证,用于管理后台和第三方系统集成。
获取车位实时状态(GET /api/v1/parking/spaces):根据parking_lot_id返回指定停车场的车位占用情况。响应包含total_spaces(总车位数)、occupied_spaces(已占用车位数)、available_spaces(可用车位数)、occupancy_rate(占用率百分比)。该接口为公开接口,可用于对外展示余位信息。
创建停车场(POST /api/v1/parking/lots):管理员接口,用于通过API创建新停车场。请求参数包括name、address、city、total_spaces、longitude、latitude、business_hours、contact_phone等。创建成功后返回parking_lot_id。
订单管理API
创建停车订单(POST /api/v1/parking/orders):传入parking_lot_id(停车场ID)、plate_number(车牌号)、vehicle_type(车辆类型car/truck/motorcycle/new_energy)。响应返回order_id、enter_time、预估费用等信息。该接口用于第三方系统触发车辆入场记录。
查询订单详情(GET /api/v1/parking/orders/:id):通过order_id获取订单完整信息,包括enter_time、exit_time、parking_duration(秒)、计费明细列表、total_fee、paid_fee、discount_fee、payment_status、payment_method等。
订单列表查询(GET /api/v1/parking/orders):支持按parking_lot_id、plate_number、status(pending/completed/cancelled/abnormal)、start_time、end_time筛选,支持分页。
结束订单(PUT /api/v1/parking/orders/:id/complete):车辆出场时调用,系统自动计算停车时长和费用。请求参数可选exit_time,不传则使用当前时间。
支付管理API
发起支付(POST /api/v1/payment/pay):支持微信支付和支付宝。请求参数包含order_id、payment_method(wechat/alipay)、amount(单位分)。响应返回支付链接或二维码字符串,以及payment_id用于后续查询。
查询支付结果(GET /api/v1/payment/result/:payment_id):返回payment_status(unpaid/paying/paid/refunding/refunded/failed)、transaction_id(第三方交易号)、payment_time等。
申请退款(POST /api/v1/payment/refund):支持全额和部分退款。请求参数包含order_id、refund_amount(单位分)、refund_reason。退款审核通过后原路返回,异步通知结果。
统计分析API
日报统计(GET /api/v1/statistics/daily):返回指定日期的运营数据,包括total_revenue、total_orders、avg_parking_duration、payment_method_distribution、peak_hours_distribution、vehicle_type_distribution等。
趋势分析(GET /api/v1/statistics/trend):支持按day/week/month维度查看数据趋势,可对比多个parking_lot_id的运营数据。返回时间序列数据,包含每日/周/月的收入、订单量、车流量等指标。