车检状态查询API

接口描述

• 根据车牌号查询车检状态
• 只有经过授权，方可调用
• 根据车牌号查询该车当前的车检业务办理状态
  • 检测进度及结果
  • 业务办理进度
  • 历史检测报告（开发中）

请求信息

HTTP协议：HTTP

调用地址：038e35c75d6c4990943c258b49d65267-cn-beijing.alicloudapi.com/api/flow

方法：POST

请求Body描述(Json)

{
    "plate_numer":"京AAR670"
}

返回信息

返回参数类型

JSON

返回结果示例

{
    "result": "success",
    "data": [
        {
            "plate_number": "京AAR670",
            "datetime": "2019-03-11 13:58:51",
            "status": "登记完成"
        },
        {
            "plate_number": "京AAR670",
            "datetime": "2019-03-11 13:58:55",
            "status": "等待尾气检测"
        },
        {
            "plate_number": "京AAR670",
            "datetime": "2019-03-11 14:05:55",
            "status": "尾气检测合格"
        },
        {
            "plate_number": "京AAR670",
            "datetime": "2019-03-13 14:44:24",
            "status": "安检检测合格"
        },
        {
            "plate_number": "京AAR670",
            "datetime": "2019-03-13 14:44:24",
            "status": "总检审核合格"
        },
        {
            "plate_number": "京AAR670",
            "datetime": "2019-03-13 16:35:23",
            "status": "检字已发"
        }
    ],
    "plate_number": "京AAR670"
}

异常返回示例

{
    "result": "fail",
    "data": []
}

API调用

公共入参

公共请求参数是指每个接口都需要使用到的请求参数。

签名计算规则

请求签名，是基于请求内容计算的数字签名，用于API识别用户身份。客户端调用API时，需要在请求中添加计算的签名（X-Ca-Signature）。

签名计算流程

准备APPkey → 构造待签名字符串stringToSign → 使用Secret计算签名

1.准备APPKey

Appkey，调用API的身份标识，可以到阿里云API网关控制台申请

2.构造待签名字符串stringToSign

String stringToSign=
HTTPMethod + "\n" +
Accept + "\n" +                //建议显示设置 Accept Header。当 Accept 为空时，部分 Http 客户端会给 Accept 设置默认值为 */*，导致签名校验失败。
Content-MD5 + "\n"
Content-Type + "\n" +
Date + "\n" +
Headers +
Url

HTTPMethod

为全大写，如 POST。

Accept、Content-MD5、Content-Type、Date 如果为空也需要添加换行符”\n”，Headers如果为空不需要添加”\n”。

Content-MD5

Content-MD5 是指 Body 的 MD5 值，只有当 Body 非 Form 表单时才计算 MD5，计算方式为：

String content-MD5 = Base64.encodeBase64(MD5(bodyStream.getbytes("UTF-8")));
bodyStream 为字节数组。

Headers

Headers 是指参与 Headers 签名计算的 Header 的 Key、Value 拼接的字符串，建议对 X-Ca 开头以及自定义 Header 计算签名，注意如下参数不参与 Headers 签名计算：X-Ca-Signature、X-Ca-Signature-Headers、Accept、Content-MD5、Content-Type、Date。

Headers 组织方法：

先对参与 Headers 签名计算的 Header的Key 按照字典排序后使用如下方式拼接，如果某个 Header 的 Value 为空，则使用 HeaderKey + “:” + “\n”参与签名，需要保留 Key 和英文冒号。

String headers =
HeaderKey1 + ":" + HeaderValue1 + "\n"\+
HeaderKey2 + ":" + HeaderValue2 + "\n"\+
...
HeaderKeyN + ":" + HeaderValueN + "\n"

将 Headers 签名中 Header 的 Key 使用英文逗号分割放到 Request 的 Header 中，Key为：X-Ca-Signature-Headers。

Url

Url 指 Path + Query + Body 中 Form 参数，组织方法：对 Query+Form 参数按照字典对 Key 进行排序后按照如下方法拼接，如果 Query 或 Form 参数为空，则 Url = Path，不需要添加 ？，如果某个参数的 Value 为空只保留 Key 参与签名，等号不需要再加入签名。

String url =
Path +
"?" +
Key1 + "=" + Value1 +
"&" + Key2 + "=" + Value2 +
...
"&" + KeyN + "=" + ValueN

注意这里 Query 或 Form 参数的 Value 可能有多个，多个的时候只取第一个 Value 参与签名计算。

3.使用Secret计算签名

Mac hmacSha256 = Mac.getInstance("HmacSHA256");
byte[] keyBytes = secret.getBytes("UTF-8");
hmacSha256.init(new SecretKeySpec(keyBytes, 0, keyBytes.length, "HmacSHA256"));
String sign = new String(Base64.encodeBase64(Sha256.doFinal(stringToSign.getBytes("UTF-8")),"UTF-8"));

Secret 为 APP 的密钥，请在应用管理中获取。

错误码

如何获取公共错误

所有的 API 请求只要到达了网关，网关就会返回请求结果信息。

用户需要查看返回结果的头部，即 Header 部分。返回参数如示例：

//请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与跟踪
X-Ca-Request-Id: 7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF

//API网关返回的错误消息，当请求出现错误时API网关会通过响应头将错误消息返回给客户端
X-Ca-Error-Message: Invalid Url

//当打开Debug模式后会返回Debug信息，此信息后期可能会有变更，仅用做联调阶段参考
X-Ca-Debug-Info: {"ServiceLatency":0,"TotalLatency":2}

在 Header 中获得 X-Ca-Error-Message 可以基本明确报错原因，而 X-Ca-Request-Id 可以用于提供给这边的支持人员，供支持人员搜索日志。

公共错误码

客户端错误

服务器端错误（调用 API）

以下为API服务端错误，如果频繁错误，可联系服务商。