
接入指南
芸豆票据API接口文档说明-V2.0
概述
嘉芸汇以其独有的资源和实力,为客户提供扫描票据的云端识别服务。 只需上传符合质量要求的(300dpi,格式为jpg)图片,即可返回票据识别的数据结果,用于后续应用。
签名验证
本接口通过调用者在header传入的'x-cid',x-oid,'x-signature','t'及c-url等相关数据,将部分数据拼合成字符串并进行md5加密生成私密钥,与调用者传入的私密钥进行比对校验,以此对客户信息进行验证。
传票需知
本接口对用户传入的'image'参数值有无及大小进行审核(不大于2M)。
票据识别接口
嘉芸汇以其独有的资源和实力,为客户提供扫描票据的云端识别服务。
只需上传符合质量要求的(300dpi,格式为jpg)图片,即可返回票据识别的数据结果,用于后续应用。
发票上传接口地址
请求方式 | url |
---|---|
POST | http(s)://cloud.yundoukuaiji.com/api/bill/upload |
Headers 以及 签名验证
参数 | 参数说明 | 备注 |
---|---|---|
x-cid | 公司ID | 相关信息联系管理员开通所要 |
x-signature | 加密参数 | 小写(md5(加密串)) |
t | 时间戳 | |
oid | 数据的id | 唯一标示,防止重新上传 (调用方提供) |
c-url | 回调地址 | 客户自定义回调地址 |
备注:
1. 加密串 = (私钥-API-公司ID-时间戳)
2. API = /api/bill/upload (接口地址)
POST 请求参数
参数 | 参数说明 | 备注 |
---|---|---|
image | 识别图片 (0,2)M | Base64(图片文件数据) |
响应参数
返回值为json
格式,示例如下
{
data: {'id':1},//返回上传的图片ID
code:1,//0、成功 1、失败
message:"",//提示信息,文字部分
}
POST 发票信息同步
备注:
1.请求地址,此地址为合作方提供的接口地址
2.信息同步规则
回掉数据结构
{
code: 0,//0成功,其他失败
x-oid:123//合作方提供的id
bid:123//票据ID
message:''//提示信息
type : 'xxx'//发票类型
data: {'xxx'}//根据发票类型返回不同的数据格式
}
type 详解
发票类型集合: 火车票,飞机票,出租车票,长途客车票,定额发票,过路过桥费,水电费,工缴费,办公用品,住宿费,停车费,快递费,电话费,船票,门票,汽油费,公交一卡通,银行发票,增值税专用发票,增值税普通发票
data 详解
发票类型 :火车票
data:{
sign_date: 日期
full_name: 姓名
id_number: 身份证号码
amount: 金额
}
发票类型 :滴滴行程单
data:{
sign_date: 日期
amount:金额
mobile: 手机号码
}
发票类型:飞机票
data:{
sign_date: 日期
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
territory: 境内外标记 1、境内 2、境外
full_name: 姓名
id_number :身份证号码
chapter:章 (1有章,2无章)
}
发票类型 :出租车票
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
time: 时间
license_number : 车号
chapter:章 (1有章,2无章)
}
发票类型 :长途客车票
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
full_name:姓名
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :定额发票
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
type:费用类型
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :过路过桥费
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :水电费
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :公交
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :办公用品
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :住宿费
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :停车费
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :快递费
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :电话费
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :船票
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :门票
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :汽油费
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
city:城市
province:省份
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型 :公交一卡通
data:{
sign_date: 日期
Invoice_code: 发票代码
invoice_number:发票号码
amount: 金额
producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
chapter:章 (1有章,2无章)
}
发票类型:银行票据
data:{
sign_date:
Amount : 金额
pay_name: 付款方名称
pay_bank: 付款方银行
pay_account: 付款方账号
recieve_name: 收款方名称
recieve_bank: 收款方银行
recieve_account:收款方账号
chapter:章 (1有章,2无章)
}
发票类型:增值税专用发票,增值税普通发票
data:{
sign_date:日期
Amount : 金额
Tax:税额
total_price:合计
vcode:校验码
invoice_code:发票代码
invoice_number:发票号码
chapter:章 (1有章,2无章)
invoice_order: 联次 0,无。10发票联 11、抵扣联 12 销方联次(包含其他等联次)
pay_name: 付款方名称
pay_bank: 付款方银行
pay_account: 付款方账号
pay_tel:付款方手机
pay_address:付款方地址
payer_tax_identification_number:付款方识别号
recieve_name: 收款方名称
recieve_bank: 收款方银行
recieve_account:收款方账号
receive_tel:收款方手机
receive_address:收款方地址
receive_tax_identification_number:收款方识别号
Item:[
{
name:摘要名称
standard:
unit:单位
number:数量
unit_price:单价
amount:金额
tax:税额
taxrate:税率
}
]
}
二维码识别接口
1.1.1 二维码上传
请求地址URL:http(s)://{host}:{port}/api/bill/qr_upload
HTTP(S)请求方式:POST
1.1.2 参与签名参数(header)
字段名 | 描述 |
---|---|
x-cid | 用户ID |
x-oid | 数据的id,唯一标示,防止重新上传(调用方提供) |
x-signature | 签名私密钥 = APIKEY,URI,用户ID,时间戳 将此数据用"-"链接 并且 md5 |
c-url | 自定义回调地址 |
t | 当前时间戳 |
1.1.3 请求参数
字段名 | 限制 | 描述 |
---|---|---|
image | (0,2)M | Base64(图片文件数据) |
1.1.4 返回结果
字段名 | 描述 |
---|---|
data | 返回的数据 |
code | 0、成功 1、失败 |
message | 提示信息,文字部分 |
1.1.5 data 详细
字段名 | 描述 |
---|---|
id | 我方数据唯一标示 |
1.1.6 返回样例
{"data":{"id":34},"code":0,"message":"\u4e0a\u4f20\u6210\u529f"}
1.2.1 二维码信息同步
字段名 | 类型 | 描述 |
---|---|---|
x-oid | srting | 合作方提供的ID |
code | int | 状态 0 成功 |
message | srting | 提示信息 |
data | array | 返回的数据 |
id | int | 发票ID |
content | string | 二维码信息 |
1.2.2 返回结果