推送车辆离场

请求地址

POST https://api.4pyun.com/gate/1.0/parking/internal/leave

特殊说明

签名计算:
如果上传文件enter_image_file时, enter_image_file文件流只参与计算得出enter_image_hash的值; enter_image_hash参与最终请求sign的计算 enter_plate_image_file 同理。

注意事项
1:同一停车场parking_serial不能重复, 重复的流水将被忽略!
2:一般情况下不传车牌图片相关字段如enter_plate_image,enter_plate_image_file,enter_plate_image_hash,该字段是特殊城市平台既要车牌拍照图片，还需要上传单独的车牌识别图片即要把大的图片里面抠出来车牌部分图片出场对应车牌图片部分同理 3:传文件有三种方式下面以入场图片为例子，后面对文件说明直接复用该地方说明
3.1:有外网可访问图片直接传enter_image
3.2:传文件字节流传了enter_image_file字段 enter_image会被忽视
4:通行证信息idcard_name,idcard_no,idcard_image是部分景区强制要求上传需要用到的才传
5:默认城市平台上传车位数据是入一辆车车位减一，出一辆车车位加一，如果中途出现断传等现象会导致下次重新上传数据不准确，针对这种情况平台建议如果本地有条件把剩余车位remain_parking_space传上来这样就不需要平台人工干预车位数了
6:开发对接过程中签名错误等信息不会直接返回错误状态码，对接过程中就判断返回结果里面是否有hint值，如果有根据hint的返回查错误原因
正式上线之后只判断code是否为200，200代表成功
7:如果需要现金找零功能推送现金记录里面推送过来，现场打印二维码给到车主具体打印规则和研发沟通找零业务
8:出场推送里面可以把入场部分数据一起推送了，一般情况不建议这样用，场景在于刚开始上报只推送出场没有入场数据，如果不希望出现这种情况可以本地记录每一条数据的入场是否推送，出场是否推送了，如果入场已经推送过，只推送出场部分，如果入场数据未推送可以在出场记录里面直接把入场数据和出场数据在出场接口里面一起传过来
9:入场推送的入场时间enter_time 和出场推送的enter_time值要一致，如果不一致平台可能会认为不是同一条记录，把出场推送的该条数据视为一条新的数据
10:hint返回结果里面如果有对象，比如payment_list对象返回来的数据，实际验证的时候里面值要去除转义比如 payment_list 对应的值[{\"change_value\":\"500\",\"free_value\":100,\"operator\":\"张三\",\"parking_order\":\"1624938055655\",\"pay_origin_desc\":\"现金\",\"pay_time\":\"1624938055655\",\"pay_type\":\"1\",\"value\":500}]
实际上参与签名的时候是这样的[{"change_value":"500","free_value":100,"operator":"张三","parking_order":"1624938055655","pay_origin_desc":"现金","pay_time":"1624938055655","pay_type":"1","value":500}]
原因是我们要从服务器返回来把"要返回来只能对它进行转义才能正常的返回前端，具体看我签名前的字符串示例

数据编码
"- 若无法正确处理UTF8编号可传递中文字段的值URLEncode后再提交, 例如提交中文ABC可编码为%E4%B8%AD%E6%96%87ABC后提交;
- 这种方式提交则计算签名的值为URLEncode后的值再做签名；
- 提交必须传递encoding=URL平台才会尝试URLDecode发送过来的数据。

请求参数

payment字段说明

请求示例

import com.chinaroad.foundation.utils.Base64Utils;
import com.chinaroad.foundation.utils.crypto.MD5;
import org.apache.http.HttpResponse;
import org.apache.http.client.fluent.Request;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.util.EntityUtils;
import org.junit.Test;

import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.TreeMap;
import java.util.stream.Collectors;

public class ParkingAPITest {

        // 配置P云提供的车场UUID
        private final String PARK_UUID = "49f0cc52-e8c7-41e3-b54d-af666b8cc11a";
        // 签名秘钥实际场景读配置
    private final String APP_SECRET = "XXXX";

    /**
     * 1个像素的图片
     */
    private final byte[] IMAGE_BYTES = Base64Utils.base64ToBytes("R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs=");

    @Test
    public void name() {
        // 自动对key进行排序
        Map<String, String> request = new TreeMap<>();
        // 平台分配的停车场UUID 实际场景读配置 必传
        request.put("park_uuid", PARK_UUID);
        // 停车场端的停车流水, 一般为入场记录ID 必传
        request.put("parking_serial", "202106028000000002");
        request.put("plate", "粤X77777");
        request.put("plate_color", "1");
        // 入场时间 , 单位ms 必传
        request.put("enter_time", System.currentTimeMillis() - 1000 * 60 * 1 + "");
        request.put("enter_gate","入口名称");
        request.put("enter_security","入口保安");
        // 车类: 1.临停车辆, 2.月卡车辆, 3.贵宾车辆(免费车), 4.储值车辆, 0.其他未知 必传
        request.put("car_type", "1");
        // 车类描述 必传
        request.put("car_desc", "临时车");
        // 车辆颜色: 1.蓝色, 2.黄色, 3.白色, 4.黑色, 5.绿色, 6.银色, 7. 灰色, 8. 橙色, -1 未知
        request.put("car_color", "1");
        // 车型: 1.小车, 2.大车, -1.未知
        request.put("vehicle_type", "1");
        // 入场人工放行原因 例如访客访问
        request.put("enter_release_reason","访问客户");
        // 总车位
        request.put("total_parking_space","100");
        // 剩余车位 如果希望传出入场的时候顺便车位数也同步了可以这里传
        request.put("remain_parking_space","10");

        boolean uploadFile = true;

        // 上传图片文件字节流需计算文件HASH, 且仅HASH参与签名, 字节流不参与
        if (uploadFile) {
            // 计算文件MD5
            request.put("leave_image_hash", MD5.encryptHEX(IMAGE_BYTES));
        } else {
            request.put("leave_image", "https://files.4pyun.com/d/4907c98b081?t=5614");
        }

        // 计算签名
        String plain = request.entrySet().stream()
                .map(e -> e.getKey() + "=" + e.getValue())
                .collect(Collectors.joining("&"));
        // 算出MD5值
        String sign = MD5.encryptHEX(plain + "&app_secret=" + APP_SECRET);
        request.put("sign", sign);
        System.out.println("加密明文: " + plain);
        System.out.println("加密结果: " + sign);

        MultipartEntityBuilder requestEntity = MultipartEntityBuilder.create()
                .setCharset(StandardCharsets.UTF_8);
        request.entrySet().forEach(e -> {
            requestEntity.addTextBody(e.getKey(), e.getValue(), ContentType.DEFAULT_TEXT.withCharset(StandardCharsets.UTF_8));
        });

        // 添加图片字节流
        if (uploadFile) {
            // 根据接口情况，添加对应的图片信息, 图片名称可以不传递
            requestEntity.addBinaryBody("leave_image_file", IMAGE_BYTES, ContentType.APPLICATION_OCTET_STREAM, "");
        }

        try {
            HttpResponse response = Request.Post("https://api.4pyun.com/gate/1.0/parking/internal/leave")
                    .body(requestEntity.build())
                    .execute()
                    .returnResponse();
            String body = EntityUtils.toString(response.getEntity());
            /**
             * 1. HTTP非200也会返回结果, 故需读取BODY!
             * 2. 该接口返回code取值200、1001、1000均表示上传成功!
             */
            // 打印返回结果
            System.out.println(body);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

}

请求返回结果参数说明

请求返回结果示例

正常返回
{
    "code": "200",
    "message": "OK",
    "seqno": "47ac4e615fa7d439",
    "data_node": "CN-South/HS3-3"
}

正常返回 带hint 对接过程中要特别注意这种情况，正式上线了这种也直接视为成功，防止一直卡在一条数据上面
{
    "code": "200",
    "message": "已忽略当前请求",
    "hint": "签名验证不通过[car_color=1&car_desc=临时车&car_type=1&enter_time=1624874732253&leave_gate=出口名称&leave_image=https://t7.baidu.com/it/u=1595072465,3644073269&fm=193&f=GIF&leave_image_hash=3EF48C1A8A95DF308EFF872082280815&leave_release_reason=离场人工放行原因&leave_security=出口保安&leave_time=1624938055655&park_uuid=49f0cc52-e8c7-41e3-b54d-af666b8cc11a&parking_serial=202106028000000007&payment_list=[{\"change_value\":\"500\",\"free_value\":100,\"operator\":\"张三\",\"parking_order\":\"1624938055655\",\"pay_origin_desc\":\"现金\",\"pay_time\":\"1624938055655\",\"pay_type\":\"1\",\"value\":500},{\"change_value\":\"0\",\"free_value\":100,\"operator\":\"\",\"parking_order\":\"1624938055755\",\"pay_origin_desc\":\"在线支付\",\"pay_time\":\"1624938055655\",\"pay_type\":\"2\",\"value\":500},{\"change_value\":\"0\",\"free_value\":0,\"operator\":\"\",\"parking_order\":\"1624938055755\",\"pay_origin_desc\":\"储值卡余额支付\",\"pay_time\":\"1624938055655\",\"pay_type\":\"4\",\"value\":500}]&plate=粤X44444&plate_color=1&remain_parking_space=10&total_parking_space=100&vehicle_type=1&app_secret=***]",
    "seqno": "6542ed9c3cbb7905",
    "data_node": "CN-South/HS3-2",
    "path": "POST /gate/1.0/parking/internal/leave"
}

参数错误
{
    "code": "400",
    "message": "请求参数错误",
    "hint": "参数`enter_time`未传递",
    "seqno": "d2d0d0dab20dc6c0",
    "data_node": "CN-South/HS3-2",
    "path": "POST /gate/1.0/parking/internal/leave"
}

// 服务器内部错误
{
    "code": "500",
    "message": "服务器内部错误",
    "seqno": "48bf04ea4caa479c",
    "data_node": "CN-South/HS3-2",
    "path": "POST /gate/1.0/parking/internal/leave"
}

服务器内部错误
{
    "code": "503",
    "message": "服务暂不可用",
    "seqno": "48bf04ea4caa479c",
    "data_node": "CN-South/HS3-2",
    "path": "POST /gate/1.0/parking/internal/leave"
}