You need to enable JavaScript to run this app.
导航

接口文档

最近更新时间2021.12.16 13:58:38

首次发布时间2021.12.16 13:58:38

接入指引

请先查看接入指引了解具体接入方式,再参考此文档完成接入。

请求API

名称内容
请求方式POST
Content-Typeapplication/x-www-form-urlencoded (传入参数不包含类型File)
是否需要鉴权
图片要求1. 图片格式:JPG、JPEG、PNG、BMP等常见格式,建议使用JPG格式。
2. 图片像素尺寸:为了保证文字识别效果,推荐图片中行程单最短边长不低于256像素。
3. 图片文件大小:最大 4 MB。行程单主体尽量占据图片主要区域。
4. 注意图片质量:保证行程单图片足够清晰,不应该有因为压缩导致的噪声,避免对行程单正反面的遮挡、不当的光照(强光、暗光、逆光)等,否则会降低结果准确度。
5. 图片需要有版权,有肖像权,没有法律或者政策风险的。相关风险请注意评估。
6.行程单图片不可以是复印件、翻拍件、PS件等。

输入参数

Query参数:

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

Body参数:

参数可选/必选类型说明
image_base64必选String行程单图片文件,base64编码

API返回

通用返回字段说明

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

data 字段说明

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

main_info 字段说明

字段类型说明备注
titleString发票抬头主页信息
nameString姓名主页信息
id_noString身份证号主页信息
fareString票价主页信息
civil_aviation_development_fundString民航发展基金主页信息
fuel_surchargeString燃油附加税主页信息
other_taxesString其他税费主页信息
totalString合计费用主页信息
e_ticket_noString电子客票号主页信息
ckString验证码主页信息
insuranceString保险费主页信息
date_of_issueString填开日期主页信息
agent_codeString销售单位代号主页信息
issued_byString填开单位主页信息
internationString国际主页信息
entry_{条目编号}_{明细字段}String见下方主页信息

entry 明细字段说明

字段类型说明备注
fromString起始站主页信息
toString终点站主页信息
carrierString承运人主页信息
flightString航班号主页信息
classString座位等级主页信息
dateString日期主页信息
timeString时间主页信息
fare_basisString客票等级主页信息

错误码

HttpCode错误码错误消息描述
20010000"Success"请求成功
40050204"Parse Request Parameters Error"缺少参数
40150205"Image Size Exceeds Maximum Limit: please compress the image"图片大小超过上限
40050207"Image Decode Error: image format unsupported"图片解码错误,文件内容为空或格式错误
40050208"Invalid Input Image: No object detected in input image, bad input image"输入图片没有检测到行程单
40150400见下方鉴权错误信息鉴权失败
40450402"Request URL Error"无效的请求路径
50050500"Internal Error: please contact with bytedance engineering team"内部错误,需要联系开发人员

返回值示例

主页面图片返回值示例

{
   "code":10000,
   "data":{
      "invoice_main":{
         "title":"航空运输电子客票行程单",
         "name":"李XX",
         "id_no":"640103********0336",
         "fuel_surcharge":"40.00",
         "fare":"1130",
         "civil_aviation_development_fund":"CY50.",
         "total":"1220.00",
         "e_ticket_no":"8803****1619",
         "date_of_issue":"2010-06-14",
         "agent_code":"WTR****SXY",
         "issued_by":"苏州快平航空票务服务",
         "entry_0.from":"上海浦东",
         "entry_0.to":"西安 XIY",
         "entry_0.time":"19JUN",
         "entry_0.fare_basis":"562"
      }
   },
   "message":"Success",
   "request_id":"68985943324423639171606204159",
   "status":10000,
   "time_elapsed":"371.220366ms"
}