导航
接口文档
最近更新时间：2021.12.16 13:58:38首次发布时间：2021.12.16 13:58:38
接入指引
请先查看接入指引了解具体接入方式，再参考此文档完成接入。
请求API
| 名称 | 内容 |
|---|---|
| 请求方式 | POST |
| Content-Type | application/x-www-form-urlencoded (传入参数不包含类型File) |
| 是否需要鉴权 | 是 |
| 图片要求 | 1. 图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG格式。 2. 图片像素尺寸：为了保证文字识别效果，推荐图片中出租车发票最短边长不低于256像素。 3. 图片文件大小：最大 4 MB。出租车发票主体尽量占据图片主要区域，不支持黑白图片。 4. 注意图片质量：保证出租车发票图片足够清晰，不应该有因为压缩导致的噪声，避免对出租车发票正反面的遮挡、不当的光照（强光、暗光、逆光）等，否则会降低结果准确度。 5. 图片需要有版权，有肖像权，没有法律或者政策风险的。相关风险请注意评估。 6.出租车发票图片不可以是复印件、翻拍件、PS件等。 |
输入参数
Query参数：
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| Action | 必选 | String | 接口名，取值：OcrTaxiInvoice |
| Version | 必选 | String | 版本号，取值：2020-08-26 |
Body参数：
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| image_base64 | 必选 | String | 出租车票图片文件，base64编码 |
API返回
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 | 盖章公司纳税人识别号 | 主页信息 |
错误码
| HttpCode | 错误码 | 错误消息 | 描述 |
|---|---|---|---|
| 200 | 10000 | "Success" | 请求成功 |
| 400 | 50204 | "Parse Request Parameters Error" | 缺少参数 |
| 401 | 50205 | "Image Size Exceeds Maximum Limit: please compress the image" | 图片大小超过上限 |
| 400 | 50207 | "Image Decode Error: image format unsupported" | 图片解码错误，文件内容为空或格式错误 |
| 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缺失或格式错误 |
注: 更多通用反馈字段通用返回值和状态码
返回值示例
主页面图片返回值示例
{ "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" }