芸豆票据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. 备注:
  2. 1. 加密串 = (私钥-API-公司ID-时间戳)
  3. 2. API = /api/bill/upload (接口地址)

POST 请求参数

参数 参数说明 备注
image 识别图片 (0,2)M Base64(图片文件数据)

响应参数

返回值为json格式,示例如下

  1. {
  2. data: {'id':1},//返回上传的图片ID
  3. code:1,//0、成功 1、失败
  4. message:"",//提示信息,文字部分
  5. }

POST 发票信息同步

  1. 备注:
  2. 1.请求地址,此地址为合作方提供的接口地址
  3. 2.信息同步规则
  1. 回掉数据结构
  2. {
  3. code: 0,//0成功,其他失败
  4. x-oid:123//合作方提供的id
  5. bid:123//票据ID
  6. message:''//提示信息
  7. type : 'xxx'//发票类型
  8. data: {'xxx'}//根据发票类型返回不同的数据格式
  9. }

type 详解

  1. 发票类型集合: 火车票,飞机票,出租车票,长途客车票,定额发票,过路过桥费,水电费,工缴费,办公用品,住宿费,停车费,快递费,电话费,船票,门票,汽油费,公交一卡通,银行发票,增值税专用发票,增值税普通发票

data 详解

  1. 发票类型 :火车票
  2. data:{
  3. sign_date: 日期
  4. full_name: 姓名
  5. id_number: 身份证号码
  6. amount: 金额
  7. }
  8. 发票类型 :滴滴行程单
  9. data:{
  10. sign_date: 日期
  11. amount:金额
  12. mobile: 手机号码
  13. }
  14. 发票类型:飞机票
  15. data:{
  16. sign_date: 日期
  17. amount: 金额
  18. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  19. territory: 境内外标记 1、境内 2、境外
  20. full_name: 姓名
  21. id_number :身份证号码
  22. chapter:章 (1有章,2无章)
  23. }
  24. 发票类型 :出租车票
  25. data:{
  26. sign_date: 日期
  27. Invoice_code: 发票代码
  28. invoice_number:发票号码
  29. amount: 金额
  30. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  31. time: 时间
  32. license_number : 车号
  33. chapter:章 (1有章,2无章)
  34. }
  35. 发票类型 :长途客车票
  36. data:{
  37. sign_date: 日期
  38. Invoice_code: 发票代码
  39. invoice_number:发票号码
  40. full_name:姓名
  41. amount: 金额
  42. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  43. chapter:章 (1有章,2无章)
  44. }
  45. 发票类型 :定额发票
  46. data:{
  47. sign_date: 日期
  48. Invoice_code: 发票代码
  49. invoice_number:发票号码
  50. type:费用类型
  51. amount: 金额
  52. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  53. chapter:章 (1有章,2无章)
  54. }
  55. 发票类型 :过路过桥费
  56. data:{
  57. sign_date: 日期
  58. Invoice_code: 发票代码
  59. invoice_number:发票号码
  60. amount: 金额
  61. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  62. chapter:章 (1有章,2无章)
  63. }
  64. 发票类型 :水电费
  65. data:{
  66. sign_date: 日期
  67. Invoice_code: 发票代码
  68. invoice_number:发票号码
  69. amount: 金额
  70. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  71. chapter:章 (1有章,2无章)
  72. }
  73. 发票类型 :公交
  74. data:{
  75. sign_date: 日期
  76. Invoice_code: 发票代码
  77. invoice_number:发票号码
  78. amount: 金额
  79. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  80. chapter:章 (1有章,2无章)
  81. }
  82. 发票类型 :办公用品
  83. data:{
  84. sign_date: 日期
  85. Invoice_code: 发票代码
  86. invoice_number:发票号码
  87. amount: 金额
  88. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  89. chapter:章 (1有章,2无章)
  90. }
  91. 发票类型 :住宿费
  92. data:{
  93. sign_date: 日期
  94. Invoice_code: 发票代码
  95. invoice_number:发票号码
  96. amount: 金额
  97. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  98. chapter:章 (1有章,2无章)
  99. }
  100. 发票类型 :停车费
  101. data:{
  102. sign_date: 日期
  103. Invoice_code: 发票代码
  104. invoice_number:发票号码
  105. amount: 金额
  106. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  107. chapter:章 (1有章,2无章)
  108. }
  109. 发票类型 :快递费
  110. data:{
  111. sign_date: 日期
  112. Invoice_code: 发票代码
  113. invoice_number:发票号码
  114. amount: 金额
  115. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  116. chapter:章 (1有章,2无章)
  117. }
  118. 发票类型 :电话费
  119. data:{
  120. sign_date: 日期
  121. Invoice_code: 发票代码
  122. invoice_number:发票号码
  123. amount: 金额
  124. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  125. chapter:章 (1有章,2无章)
  126. }
  127. 发票类型 :船票
  128. data:{
  129. sign_date: 日期
  130. Invoice_code: 发票代码
  131. invoice_number:发票号码
  132. amount: 金额
  133. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  134. chapter:章 (1有章,2无章)
  135. }
  136. 发票类型 :门票
  137. data:{
  138. sign_date: 日期
  139. Invoice_code: 发票代码
  140. invoice_number:发票号码
  141. amount: 金额
  142. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  143. chapter:章 (1有章,2无章)
  144. }
  145. 发票类型 :汽油费
  146. data:{
  147. sign_date: 日期
  148. Invoice_code: 发票代码
  149. invoice_number:发票号码
  150. city:城市
  151. province:省份
  152. amount: 金额
  153. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  154. chapter:章 (1有章,2无章)
  155. }
  156. 发票类型 :公交一卡通
  157. data:{
  158. sign_date: 日期
  159. Invoice_code: 发票代码
  160. invoice_number:发票号码
  161. amount: 金额
  162. producer: 监制章 61国家税务总局 62 国家税务局 63 其他(包含地方等监制)
  163. chapter:章 (1有章,2无章)
  164. }
  165. 发票类型:银行票据
  166. data:{
  167. sign_date:
  168. Amount : 金额
  169. pay_name 付款方名称
  170. pay_bank 付款方银行
  171. pay_account 付款方账号
  172. recieve_name 收款方名称
  173. recieve_bank 收款方银行
  174. recieve_account:收款方账号
  175. chapter:章 (1有章,2无章)
  176. }
  177. 发票类型:增值税专用发票,增值税普通发票
  178. data:{
  179. sign_date:日期
  180. Amount : 金额
  181. Tax:税额
  182. total_price:合计
  183. vcode:校验码
  184. invoice_code:发票代码
  185. invoice_number:发票号码
  186. chapter:章 (1有章,2无章)
  187. invoice_order: 联次 0,无。10发票联 11、抵扣联 12 销方联次(包含其他等联次)
  188. pay_name 付款方名称
  189. pay_bank 付款方银行
  190. pay_account 付款方账号
  191. pay_tel:付款方手机
  192. pay_address:付款方地址
  193. payer_tax_identification_number:付款方识别号
  194. recieve_name 收款方名称
  195. recieve_bank 收款方银行
  196. recieve_account:收款方账号
  197. receive_tel:收款方手机
  198. receive_address:收款方地址
  199. receive_tax_identification_number:收款方识别号
  200. Item:[
  201. {
  202. name:摘要名称
  203. standard:
  204. unit:单位
  205. number:数量
  206. unit_price:单价
  207. amount:金额
  208. tax:税额
  209. taxrate:税率
  210. }
  211. ]
  212. }

二维码识别接口

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 返回结果