文档中心

调用方式

最近更新时间：2023.08.07 16:49:09

首次发布时间：2022.07.21 17:01:20

接口简介

支持对出租车发票关键字段的自动定位与识别。

限制条件

名称	内容
输入要求	1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF等常见格式，建议使用JPG格式。 2. 图片像素尺寸：为了保证文字识别效果，推荐图片中出租车发票最短边长不低于256像素。 3. 文件大小： a.要求Base64编码和urlencode之后不超过 8 MB。出租车发票主体尽量占据图片主要区域，不支持黑白图片。 b.如果传图片及PDF完整URL，URL对应文件大小建议不要超过8MB。 4. 输入文件过大时，返回的HttpCode如下：400/413/502。 5. 注意图片质量：保证出租车发票图片足够清晰，不应该有因为压缩导致的噪声，避免对出租车发票正反面的遮挡、不当的光照（强光、暗光、逆光）等，否则会降低结果准确度。 6. 图片需要有版权，有肖像权，没有法律或者政策风险的。相关风险请注意评估。 7. 输入多页PDF时，默认只识别第一页。

名称

内容

输入要求

1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF等常见格式，建议使用JPG格式。
2. 图片像素尺寸：为了保证文字识别效果，推荐图片中出租车发票最短边长不低于256像素。
3. 文件大小：
a.要求Base64编码和urlencode之后不超过 8 MB。出租车发票主体尽量占据图片主要区域，不支持黑白图片。
b.如果传图片及PDF完整URL，URL对应文件大小建议不要超过8MB。
4. 输入文件过大时，返回的HttpCode如下：400/413/502。
5. 注意图片质量：保证出租车发票图片足够清晰，不应该有因为压缩导致的噪声，避免对出租车发票正反面的遮挡、不当的光照（强光、暗光、逆光）等，否则会降低结果准确度。
6. 图片需要有版权，有肖像权，没有法律或者政策风险的。相关风险请注意评估。
7. 输入多页PDF时，默认只识别第一页。

请求说明

基本信息

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/x-www-form-urlencoded (传入参数不包含类型File)
是否需要鉴权	是

请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数。

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，文字识别一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

Query请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：OcrTaxiInvoice
Version	必选	String	版本号，取值：2020-08-26

Body参数

参数	可选/必选	类型	说明
image_base64	与image_url二选一	String	图片文件，base64编码注意: 只需要传图片的base64值，类似data:image/png;base64的图片头不要传入
image_url	与image_base64二选一	String	图片/PDF文件的URL链接注意: 要求image_base64与image_url二选一，如果2个字段都有，优先解析image_base64。

输出说明

通用输出参数

请参考通用返回字段及错误码 |

业务输出参数

data 字段说明

字段	类型	说明	备注
invoice_main	main_info	主页面信息	字段说明见下方

main_info 字段说明

字段	类型	说明	备注
total_amount	String	金额	主页信息
distance	String	里程	主页信息
price	String	单价	主页信息
end_time	String	结束时间	主页信息
start_time	String	开始时间	主页信息
start_date	String	日期	主页信息
car_number	String	车号	主页信息
invoice_no	String	发票号码	主页信息
invoice_code	String	发票代码	主页信息
dispatch_fee	String	调度费	主页信息
title_trial	String	发票名称	主页信息
additional_fee	String	附加费	主页信息
is_sealed	String	是否加盖章	主页信息
seller_name_in_seal	String	盖章公司名称	主页信息
seller_taxpayer_no_in_seal	String	盖章公司纳税人识别号	主页信息

输出示例

图片返回值示例

{
   "code":10000,
   "data":{
      "invoice_main":{
         "total_amount":"97.00",
         "distance":"32.8",
         "price":"3.45",
         "end_time":"11:03",
         "start_time":"10:16",
         "start_date":"2019-04-29",
         "car_number":"B-N0645",
         "invoice_no":"76172991",
         "invoice_code":"111001881001",
         "dispatch_fee":"0.00",
         "title_trial":"北京市出租汽车专用发票",
         "additional_fee":"1.00",
         'is_sealed': 'true',
         'seller_name_in_seal': '北京市出租汽车'
      }
   },
   "message":"Success",
   "request_id":"68944300900551250001605234595",
   "status":10000,
   "time_elapsed":"574.32861ms"
}

错误码

通用错误码

请参考通用返回字段及错误码

业务错误码

HttpCode	错误码	错误消息	描述
200	10000	"Success"	请求成功
400	50204	"Parse Request Parameters Error"	缺少参数
400	50205	"Image Size Exceeds Maximum Limit: please compress the image"	输入文件过大
400	50206	"Invalid Input Image: image is empty"	输入图片为空
400	50207	"Image Decode Error: image format unsupported"	图片解码错误
400	50217	"Process PDF File Error."	处理PDF文件错误
400	50208	"Invalid Input Image: No object detected in input image, bad input image"	输入图片没有检测到出租车发票
401	50400	见下方鉴权错误信息	鉴权失败
404	50402	"Request URL Error"	无效的请求路径
500	50500	"Internal Error: please contact with bytedance engineering team"	内部错误，需要联系开发人员

鉴权错误信息

HttpCode	错误码	错误消息	描述
401	50400	"Access Denied: api forbidden"	api_key缺失或者错误
401	50400	"Access Denied: bad timestamp. Make sure your clock is correct"	timestamp错误
401	50400	"Access Denied: timestamp is an invalid integer"	timestamp缺失或格式错误
401	50400	"Access Denied: nonce is not a 32-bit signed integer"	nonce缺失或格式错误
401	50400	"Access Denied: bad signature"	sign缺失或格式错误