推送车辆入场

请求地址

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

特殊说明

签名计算:
如果上传文件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会被忽视
enter_image_file
4:通行证信息idcard_name,idcard_no,idcard_image是部分景区强制要求上传需要用到的才传
5:默认城市平台上传车位数据是入一辆车车位减一,出一辆车车位加一,如果中途出现断传等现象会导致下次重新上传数据不准确,针对这种情况平台建议如果本地有条件把剩余车位remain_parking_space传上来这样就不需要平台人工干预车位数了
6:开发对接过程中签名错误等信息不会直接返回错误状态码,对接过程中就判断返回结果里面是否有hint值,如果有根据hint的返回查错误原因
正式上线之后只判断code是否为200,200代表成功

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

请求参数

字段名称 字段说明 类型 必填 示例
app_id 平台分配的接入应用ID, 车场本地发起请求可不传递 string N op1234567723122
sign 请求数据签名 string Y C65FCAC2D3FB5E2D3D4AD93DD20C8C39
merchant 平台分配的停车场商户号, merchantpark_uuid二选一必传 string Y/N 62626601
park_uuid 平台分配的停车场UUID, merchantpark_uuid二选一必传 string N/Y PARKUUID-XXXX-XXX-XXX
api_type 接口类型配合app_id使用不传app_id的不传该字段 string Y XXX-SERVICE
parking_serial 停车场端的停车流水, 一般为入场记录ID string Y PARKINGSERIAL-123456789
plate 车牌号码 string N 粤B12345
plate_color 车牌颜色: 1.蓝色, 2.黄色, 3.白色, 4.黑色, 5.绿色, -1 未知 string Y 1
plate_type 车牌类型: 0-中国大陆车牌, 1-境外车牌(含港澳), 2-两轮电动车车牌 int N 1
card_no 逻辑卡号 string N 1000001
card_id 物理卡号 string N AED123A
enter_time 入场时间, 单位ms string Y 1552976318722
enter_image 入场图片路径, 任意路径 string N 可访问云平台路径-->https://files.4pyun.com/d/123566
enter_image_file 入场图片文件 string N 字节流
enter_image_hash 入场图片文件MD5哈希, 传递enter_image_file时候必须传递上传文件的哈希值。 string N XXXXXXX
enter_plate_image 入场车牌图片路径, 任意路径 string N https://files.4pyun.com/d/123566
enter_plate_image_file 入场车牌图片文件 string N 二进制文件流
enter_plate_image_hash 入场车牌图片文件MD5哈希, 传递enter_plate_image_file时候必须传递上传文件的哈希值。 string N XXXXXXX
enter_gate 入口名称 string N 东门入口
enter_security 入口保安 string N 张三
car_type 车类: 1.临停车辆, 2.月卡车辆, 3.贵宾车辆(免费车), 4.储值车辆, 0.其他未知 string Y 1
car_desc 车类描述 string Y 临停/月卡A
car_color 车辆颜色: 1.蓝色, 2.黄色, 3.白色, 4.黑色, 5.绿色, 6.银色, 7. 灰色, 8. 橙色, -1 未知 string N 1
charge_type 车辆计费标准 string Y 1
vehicle_type 车型: 1.小车, 2.大车, 3.电动自行车/摩托车, -1.未知 string N 1
idcard_name 通行证件姓名 string N 阿Q
idcard_no 通行证件号码 string N 9527123
idcard_image 通行证件图片 string N https://a.b.c/d.jpg
enter_release_reason 入场人工放行原因 string N 访问客户
total_parking_space 车场总车位数 string N 100
remain_parking_space 剩余可用车位数, 仅当total_parking_space>0生效! string N 10

请求示例

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("enter_image_hash", MD5.encryptHEX(IMAGE_BYTES));
        } else {
            request.put("enter_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("enter_image_file", IMAGE_BYTES, ContentType.APPLICATION_OCTET_STREAM, "");
        }

        try {
            HttpResponse response = Request.Post("https://api.4pyun.com/gate/1.0/parking/internal/enter")
                    .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 请求状态码 string Y 200:成功受理
400:参数错误
403:访问被拦截
500:服务器内部错误
503:服务暂不可用
message 返回描述 string Y 返回描述
hint 返回错误说明 string N 返回具体错描述指导
seqno 服务器日志标示 string Y 查日志用到查问题尽量提供这个值

请求返回结果示例:

正常返回
{
    "code": "200",
    "message": "OK",
    "seqno": "abc6c253b93cc940",
    "data_node": "CN-South/HS3-1",
    "vehicle_violation_count": 0,
    "vehicle_inspect_state": 1,
    "vehicle_insurance_state": 1
}
正常返回 带hint 对接过程中要特别注意这种情况,正式上线了这种也直接视为成功,防止一直卡在一条数据上面
{
    "code": "200",
    "message": "已忽略当前请求",
    "hint": "签名验证不通过[car_color=1&car_desc=临时车&car_type=1&enter_gate=入口名称&enter_image=https://t7.baidu.com/it/u=1595072465,3644073269&fm=193&f=GIF&enter_image_hash=3EF48C1A8A95DF308EFF872082280815&enter_release_reason=访问客户&enter_security=入口保安&enter_time=1624874732253&park_uuid=49f0cc52-e8c7-41e3-b54d-af666b8cc11a&parking_serial=202106028000000007&plate=粤X44444&plate_color=1&remain_parking_space=10&total_parking_space=100&vehicle_type=1&app_secret=***]",
    "seqno": "e820972bdf2eaf19",
    "data_node": "CN-South/HS3-3",
    "path": "POST /gate/1.0/parking/internal/enter"
}
参数错误
{
    "code": "400",
    "message": "请求参数错误",
    "hint": "参数`enter_time`未传递",
    "seqno": "48bf04ea4caa479c",
    "data_node": "CN-South/HS3-2",
    "path": "POST /gate/1.0/parking/internal/enter"
}
服务器内部错误
{
    "code": "500",
    "message": "服务器内部错误",
    "seqno": "48bf04ea4caa479c",
    "data_node": "CN-South/HS3-2",
    "path": "POST /gate/1.0/parking/internal/enter"
}
服务器内部错误
{
    "code": "503",
    "message": "服务暂不可用",
    "seqno": "48bf04ea4caa479c",
    "data_node": "CN-South/HS3-2",
    "path": "POST /gate/1.0/parking/internal/enter"
}
© 2023 Shenzhen ChinaRoad Technology Co., Ltd. © All Rights Reserved            UPDATED 2024/06/14 12:00:57

results matching ""

    No results matching ""