# 车牌识别 JD API 文档

# 接口说明

基于深度学习技术，利用光学字符识别技术，可对输入的图片自动识别车牌字段信息，识别准确率业内领先，稳定可靠。
该能力是通过HTTP API的方式给开发者提供一个通用的接口。HTTP API适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点。另外，请注意该接口使用的HTTP API协议不支持跨域。

# 接口Demo

示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo，其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

# 接口要求

集成车牌识别API时，需按照以下要求。

# 接口调用流程

· 通过接口密钥基于hmac-sha256计算签名，将签名以及其他参数加在请求地址后面。详见下方 鉴权认证 。
· 将请求参数以及图片数据放在Http Request Body中，以POST表单的形式提交，详见下方 请求参数 。
· 向服务器端发送Http请求后，接收服务器端的返回结果。

# 鉴权认证

在调用业务接口时，请求方需要对请求进行签名，服务端通过签名来校验请求的合法性。

# 鉴权方法

通过在请求地址后面加上鉴权相关参数的方式，参数具体如下：

http示例url：

https://api.xf-yun.com/v1/private/jd_ocr_car?authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0ialpqMUFQdmdIN0hJQzh3dGlnanVBc3FnNTkrbnNiZlY5S1czQzBXdjhYUT0i&host=api.xf-yun.com&date=Wed%2C+05+Aug+2020+08%3A48%3A03+GMT

鉴权参数：

date必须是UTC+0或GMT时区，RFC1123格式(Wed, 05 Aug 2020 08:48:03 GMT)。
服务端会对date进行时钟偏移检查，最大允许300秒的偏差，超出偏差的请求都将被拒绝。

· authorization参数生成格式：

1）获取接口密钥APIKey 和 APISecret。
在讯飞开放平台控制台，创建一个应用后打开车牌识别页面可以获取，均为32位字符串。

2）参数authorization base64编码前（authorization_origin）的格式如下。

api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"

其中 api_key 是在控制台获取的APIKey，algorithm 是加密算法（仅支持hmac-sha256），headers 是参与签名的参数（见下方注释）。
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串，详见下方。

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

3）signature的原始字段(signature_origin)规则如下。

signature原始字段由 host，date，request-line三个参数按照格式拼接成，
拼接的格式为(\n为换行符,’:’后面有一个空格)：

host: $host\ndate: $date\n$request-line

假设

请求url = api.xf-yun.com
date = Wed, 05 Aug 2020 08:48:03 GMT

那么 signature原始字段(signature_origin)则为：

host: api.xf-yun.com
date: Wed, 05 Aug 2020 08:48:03 GMT
POST /v1/private/jd_ocr_car HTTP/1.1

4）使用hmac-sha256算法结合apiSecret对signature_origin签名，获得签名后的摘要signature_sha。

signature_sha=hmac-sha256(signature_origin,$apiSecret)

其中 apiSecret 是在控制台获取的APISecret

5）使用base64编码对signature_sha进行编码获得最终的signature。

signature=base64(signature_sha)

假设

APISecret = apisecretXXXXXXXXXXXXXXXXXXXXXXX	
date = Wed, 05 Aug 2020 08:48:03 GMT

则signature为

signature=jZj1APvgH7HIC8wtigjuAsqg59+nsbfV9KW3C0Wv8XQ=

6）根据以上信息拼接authorization base64编码前（authorization_origin）的字符串，示例如下。

api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="jZj1APvgH7HIC8wtigjuAsqg59+nsbfV9KW3C0Wv8XQ="

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

7）最后再对authorization_origin进行base64编码获得最终的authorization参数。

authorization = base64(authorization_origin)
示例：
authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0ialpqMUFQdmdIN0hJQzh3dGlnanVBc3FnNTkrbnNiZlY5S1czQzBXdjhYUT0i

# 鉴权结果

如果鉴权失败，则根据不同错误类型返回不同HTTP Code状态码，同时携带错误描述信息，详细错误说明如下：

认证失败返回示例：

HTTP/1.1 403 Forbidden
Date: Thu, 06 Dec 2018 07:55:16 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
    "message": "HMAC signature does not match"
}

# 请求参数

在调用业务接口时，都需要在 Http Request Body 中配置以下参数，请求数据均为json字符串。

请求参数示例：
上传图片数据的方式：

{
  "header": {
    "app_id": "xxxxxxxx",
    "status": 3
  },
  "parameter": {
    "jd_ocr_car": {
      "carLicenseRes": {
        "encoding": "utf8",
        "compress": "raw",
        "format": "json"
      }
    }
  },
  "payload": {
    "carImgBase64Str": {
      "encoding": "jpg",
      "status": 3,
      "image": "/9j/4AAQ..."
    }
  }
}

上传图片URL的方式：

{
  "header": {
    "app_id": "xxxxxxxx",
    "status": 3
  },
  "parameter": {
    "jd_ocr_car": {
      "carLicenseRes": {
        "encoding": "utf8",
        "compress": "raw",
        "format": "json"
      }
    }
  },
  "payload": {
    "carImgUrl": {
      "encoding": "utf8",
      "compress": "raw",
      "format": "plain",
      "status": 3,
      "text": "aHR0cHM6Ly9hcGktZGVtby5zMy5jbi1ub3J0aC0xLmpkY2xvdWQtb3NzLmNvbS8zMC0xOTEyMTAwOTQwMDM1MTUuanBn"
    }
  }
}

# 返回参数

返回参数示例：

{
  "header": {
    "code": 0,
    "message": "success",
    "sid": "asexxxxxxxxxxxxxxxxx"
  },
  "payload": {
    "carLicenseRes": {
      "compress": "raw",
      "encoding": "utf8",
      "format": "json",
      "text": "W3sibG9jYXRpb24iOlsxNDcsNDY3LDk2NCw0NjcsOTY0LDcyMiwxNDcsNzIyXSwicHJvYmFiaWxpdHkiOjAuOTk3NDc0NDkxNTk2MjIxOSwidGV4dCI6IuiLj0UwNUVWOCJ9XQ=="
    }
  }
}

base64解码后的text示例：

[
  {
    "location": [
      448,
      652,
      578,
      650,
      580,
      691,
      448,
      694
    ],
    "probability": 0.9990984201431274,
    "text": "京H12345"
  },
  {
    "location": [
      1265,
      610,
      1391,
      608,
      1393,
      647,
      1265,
      650
    ],
    "probability": 0.9946907758712769,
    "text": "京J54321"
  },
  {
    "location": [
      110,
      93,
      196,
      93,
      200,
      123,
      110,
      125
    ],
    "probability": 0.998703122138977,
    "text": "京B67890"
  }
]

# 错误码

备注：如出现下述列表中没有的错误码，可到 这里 查询。

# 调用示例

车牌识别demo python3语言

车牌识别demo java语言

注： 其他开发语言请参照 接口调用流程 进行开发，也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

# 常见问题

# 车牌识别的主要功能是什么？

答：基于深度学习技术，利用光学字符识别技术，可对输入的图片自动识别车牌字段信息，识别准确率业内领先，稳定可靠。

# 车牌识别支持什么应用平台？

答：目前支持Web API应用平台。