setting alipay wechat success appmanage dollor user cart order workorder logout left1 left2 app unfree free chart coupon note copy pencil price-tag database cog bin list link plus minus codepen 审核 cross table search user-tie eye github cancel-circle checkmark icon-upload icon-smartphon icon-auth-user icon-arroba-symbol icon-check-pass icon-red-cross icon-pwd-key icon-used icon-expired android appleinc tux windows8 java webAPI mail vip

    # 驾驶证识别 JD API 文档

    # 接口说明

    可对输入的图片自动识别驾驶证信息,兼顾驾驶证首页和副页,提取驾驶人员的身份信息,输出关键字段,识别准确率高,稳定可靠。
    该能力是通过HTTP API的方式给开发者提供一个通用的接口。HTTP API适用于一次性交互数据传输的AI服务场景,块式传输。相较于SDK,API具有轻量、跨语言的特点。另外,请注意该接口使用的HTTP API协议不支持跨域。

    # 接口Demo

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

    # 接口要求

    集成驾驶证识别API时,需按照以下要求。

    内容 说明
    传输方式 http[s] (为提高安全性,强烈推荐https)
    请求地址 http[s]: //api.xf-yun.com/v1/private/jd_ocr_driver
    注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用
    请求行 POST /v1/private/jd_ocr_driver HTTP/1.1
    接口鉴权 签名机制,详情请参照下方鉴权认证
    字符编码 UTF-8
    响应格式 统一采用JSON格式
    开发语言 任意,只要可以向讯飞云服务发起HTTP请求的均可
    适用范围 任意操作系统,但因不支持跨域不适用于浏览器
    图片格式 jpg/png/bmp
    图片大小 base64编码后大小不超过4M

    # 接口调用流程

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

    # 鉴权认证

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

    # 鉴权方法

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

    http示例url:

    https://api.xf-yun.com/v1/private/jd_ocr_driver?authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iMlJDb0IralZBdXZtMHB2ZkJUTThwN245WGhyU2g1N1gzdXlUV0RUdjFuVT0i&host=api.xf-yun.com&date=Wed%2C+05+Aug+2020+08%3A24%3A35+GMT
    

    鉴权参数:

    参数 类型 必须 说明 示例
    host string 请求主机 api.xf-yun.com
    date string 当前时间戳,RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z") Wed, 05 Aug 2020 08:24:35 GMT
    authorization string 使用base64编码的签名相关信息(签名基于hmac-sha256计算) 参考下方详细生成规则

    · date参数生成规则:

    date必须是UTC+0或GMT时区,RFC1123格式(Wed, 05 Aug 2020 08:24:35 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:24:35 GMT
    

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

    host: api.xf-yun.com
    date: Wed, 05 Aug 2020 08:24:35 GMT
    POST /v1/private/jd_ocr_driver 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:24:35 GMT
    

    则signature为

    signature=2RCoB+jVAuvm0pvfBTM8p7n9XhrSh57X3uyTWDTv1nU=
    

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

    api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="2RCoB+jVAuvm0pvfBTM8p7n9XhrSh57X3uyTWDTv1nU="
    

    注: headers是参与签名的参数,请注意是固定的参数名("host date request-line"),而非这些参数的值。

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

    authorization = base64(authorization_origin)
    示例:
    authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iMlJDb0IralZBdXZtMHB2ZkJUTThwN245WGhyU2g1N1gzdXlUV0RUdjFuVT0i
    

    # 鉴权结果

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

    HTTP Code 说明 错误描述信息 解决方法
    401 缺少authorization参数 {"message":"Unauthorized"} 检查是否有authorization参数,详情见authorization参数详细生成规则
    401 签名参数解析失败 {“message”:”HMAC signature cannot be verified”} 检查签名的各个参数是否有缺失是否正确,特别确认下复制的api_key是否正确
    401 签名校验失败 {“message”:”HMAC signature does not match”} 签名验证失败,可能原因有很多。
    1. 检查api_key,api_secret 是否正确。
    2.检查计算签名的参数host,date,request-line是否按照协议要求拼接。
    3. 检查signature签名的base64长度是否正常(正常44个字节)。
    403 时钟偏移校验失败 {“message”:”HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication”} 检查服务器时间是否标准,相差5分钟以上会报此错误

    认证失败返回示例:

    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 object 用于上传平台参数
    header.app_id string 在平台申请的appid信息
    header.status string 请求状态,取值范围为:3(一次传完)
    parameter object 用于上传服务特性参数
    parameter.jd_ocr_driver object 用于上传功能参数
    parameter.jd_ocr_driver.driverLicenseRes object 用于上传响应数据参数
    parameter.jd_ocr_driver.driverLicenseRes.encoding string 文本编码,可选值:utf8(默认值)
    parameter.jd_ocr_driver.driverLicenseRes.compress string 文本压缩格式,可选值:raw(默认值)
    parameter.jd_ocr_driver.driverLicenseRes.format string 文本格式,可选值:json(默认值)
    payload object 用于上传请求数据
    payload.driverLicense object 用于上传一张图像数据
    payload.driverLicense.encoding string 图像编码
    可选值:
    jpg:jpg格式(默认值)
    jpeg:jpeg格式
    png:png格式
    bmp:bmp格式
    payload.driverLicense.image string 图像数据,base64编码,需保证图像文件大小base64编码后不超过4MB
    payload.driverLicense.status int 数据状态,取值范围为:3(一次传完)

    请求参数示例:

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

    # 返回参数

    参数名 类型 描述
    header object 协议头部,用于描述平台特性的参数
    header.sid string 本次会话id
    header.code int 返回码
    0表示会话调用成功,详情请参考错误码
    header.message string 描述信息
    payload object 数据段,用于携带响应的数据
    payload.driverLicenseRes object 驾驶证识别响应数据块
    payload.driverLicenseRes.compress string 文本压缩格式,仅在设置了parameter.jd_ocr_driver.driverLicenseRes.compress参数时返回
    payload.driverLicenseRes.encoding string 文本编码,仅在设置了parameter.jd_ocr_driver.driverLicenseRes.encoding参数时返回
    payload.driverLicenseRes.format string 文本格式,仅在设置了parameter.jd_ocr_driver.driverLicenseRes.format参数时返回
    payload.driverLicenseRes.text string 驾驶证识别返回结果,需要对其进行base64解码,解码后的返回字段如下

    text字段具体信息
    参数名 类型 描述
    address string 住址
    birthday string 生日
    class string 准驾车型
    country string 国籍
    file_id string 档案编号
    id string 证件号
    issue_date string 初次领证日期
    name string 姓名
    record string 检验记录
    sex string 性别
    valid_for string 有效期
    valid_from string 有效起始日期

    返回参数示例:

    {
      "header": {
        "code": 0,
        "message": "success",
        "sid": "asexxxxxxxxxxxxxxx"
      },
      "payload": {
        "driverLicenseRes": {
          "compress": "raw",
          "encoding": "utf8",
          "format": "json",
          "text": "eyJhZGRyZXNzIjoi5bGx5Lic55yB5YyX5Lqs5biC5Liw5Y+w5Yy65Liw5Y+w6ZWH5Lic5aSn6KGXMTHlj7flkajlkIzpobrliY3lj7giLCJiaXJ0aGRheSI6IjE5NzEtMTAtMjgiLCJjbGFzcyI6IkMxIiwiY291bnRyeSI6IuS4reWbvSIsImZpbGVfaWQiOiIiLCJpZCI6IjMyNDcxNDEzMTExOTc4MjAxNyIsImlzc3VlX2RhdGUiOiIxOTk5LTEyLTE0IiwibmFtZSI6IuW3peS7juS4rSIsInJlY29yZCI6IiIsInNleCI6IueUtyIsInZhbGlkX2ZvciI6IjEw5bm0IiwidmFsaWRfZnJvbSI6IjIwMTAtMTItMTQifQ=="
        }
      }
    }
    

    base64解码后的text示例:

    {
      "address": "安徽省合肥市高新区XXXXXXXX",
      "birthday": "1991-10-28",
      "class": "C1",
      "country": "中国",
      "file_id": "",
      "id": "340881199110282017",
      "issue_date": "2018-12-14",
      "name": "李四",
      "record": "",
      "sex": "男",
      "valid_for": "10年",
      "valid_from": "2028-12-14"
    }
    

    # 错误码

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

    错误码 错误描述 说明 处理方式
    10010 service license not enough 授权不足 联系技术人员
    10009 input invalid data 输入数据非法 检查图片数据是否正确上传,尤其是driverLicense参数是否正确上传
    10019 service read buffer timeout, session timeout session 超时 联系技术人员
    10163 param validate error:... 参数校验失败 1)依据错误提示信息检查参数是否正确上传
    2)检查图片大小是否超过上限,base64编码后大小不能超过4M
    10313 invalid appid appid不合法 检查app_id参数是否正确上传或是否为空
    10909 XXXXX;code=XXXXX 引擎处理异常 1)检查图片格式是否不符合要求(jpg/png/bmp)
    2)检查图片数据是否正确上传,尤其是payload中的image是否传入
    3)根据错误信息的code查询原因
    12001 image does not exist 图像不存在 检查图片数据是否正确上传
    12002 image format error 图像格式错误 检查图片格式是否符合要求(jpg/png/bmp)
    12003 image size error 图像大小错误 检查图片大小是否超过上限
    13002 time out 超时 检查网络连接是否正常
    13004 no content recognition 无内容识别 检查上传的图片是否为驾驶证图片
    13005 other error 其他错误 联系技术人员

    # 调用示例

    驾驶证识别demo python3语言

    驾驶证识别demo java语言

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

    # 常见问题

    # 驾驶证识别的主要功能是什么?

    答:可对输入的图片自动识别驾驶证信息,兼顾驾驶证首页和副页,提取驾驶人员的身份信息,输出关键字段,识别准确率高,稳定可靠。

    # 驾驶证识别支持什么应用平台?

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