影像系统对接
变更历史
日期 | 变更描述 | 变更人 | 版本 |
---|---|---|---|
2021/06/06 | 接口规范初版 | 曹云 | V1.6.0 |
2021/08/18 | 添加签名方式 | 雷权春 | V1.8.0 |
2021/12/13 | 接口补充 | 曹云 | V2.0.0 |
对接约定
发票云API采用RESTfull的设计方式,客户端通过HTTP协议的GET、POST(目前主要是这两种)方法请求进行调用。
Restful:参考资料
http://www.infoq.com/cn/articles/designing-restful-http-apps-roth
API的调用地址基本上遵循如下约定的方式:
API地址前缀+ 服务 + 资源+ 参数

签名方式
1.
2.
获取影像token授权
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /archivebase/scan/login/token |
请求参数格式 | Content-Type: application/json; charset=utf-8 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
clientId | String | 是 | 企业授权,税号维度 |
sign | String | 是 | 签名(由client_id + client_secret + timestamp的值MD5加密生成) |
timestamp | Long | 是 | 私有部署可为空,云服务必须传企业授权, 时间戳 |
fphoneNumber | String | 是 | 用户手机号码 |
fuserName | String | 是 | 用户名称 |
fuserEmail | String | 否 | 用户邮箱 |
ftaxNo | String | 否 | 用户所在组织企业 |
feasUid | String | 否 | 该用户在对接系统的用户唯一ID |
fsource | Integer | 是 | 操作系统来源:1-发票云 2-eas 3-星空 4-苍穹 5-OA 6国信 7道克维斯 8单多啦 9优易迅 10 金茂 15 汉德 99其他 |
language | String | 否 | 语言版本默认中国, zh-CN:中国、en-US:美国、es-ES :西班牙、fr-FR:法国、de-DE :德国 |
字段名称 | 字段类型 | 说明 |
---|---|---|
accessToken | string | 授权token |
expiresTime | Long | 有效时间(秒) |
文件上传(带文件加密)
文件上传(文件方式)
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /imgsys/bill/outside/file/upload?access_token={ access_token } |
请求参数格式 | Content-Type: multipart/form-data; charset=utf-8 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
file | MultipartFile | 是 | 文件 |
hashType | int | 是 | 加密方式:0-无 1-MD5 2-SHA-256 |
字段名称 | 字段类型 | 说明 |
---|---|---|
fileId | String | 文件存储fileId |
hashCode | String | 文件加密后的值 |
文件上传(url方式)
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /imgsys/bill/outside/file/uploadByUrl?access_token={ access_token } |
请求参数格式 | Content-Type: application/json; charset=utf-8 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
url | String | 是 | 文件 |
hashType | int | 是 | 加密方式:0-无 1-MD5 2-SHA-256 |
fileName | String | 否 | 文件名 |
字段名称 | 字段类型 | 说明 |
---|---|---|
fileId | String | 文件存储fileId |
hashCode | String | 文件加密后的值 |
绑定单据影像关系
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /imgsys/bill/outside/scanbill/add?access_token={ access_token } |
请求参数格式 | Content-Type: application/json; charset=utf-8 |
字段名称 | 字 段类型 | 是否必填 | 说明 |
---|---|---|---|
fscanBillNo | String | 是 | 影像编号 |
scanOutsideFileVoList | List | 是 | 影像集合 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
coverFlag | Int | 是 | 是否是封面:0-发票 1-封面 2-附件(同一影像编号下只能有一个封面) |
fileId | String | 是 | 文件fileId |
fcategoryName | String | 否 | 影像类型 |
对外影像附件上传api接口
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /imgsys/bill/outside/attachment/upload?access_token={ access_token } |
请求参数格式 | Content-Type: multipart/form-data; charset=utf-8 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
file | MultipartFile | 是 | 文件 |
fscanBillNo | String | 是 | 影像编号 |
fcategoryName | String | 否 | 影像类型 |
删除影像
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /imgsys/bill/outside/scanbill/delete?access_token={ access_token } |
请求参数格式 | Content-Type: application/json; charset=utf-8 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
fscanBillNo | String | 是 | 影像编号 |
fileIds | List<String> | 否 | 需要删除的影像fileId集合(为空则根据影像编号删除整单) |
删除单据影像-整单删除(独立接口,不可逆)
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /imgsys/bill/outside/delete?access_token={ access_token } |
请求参数格式 | Content-Type: application/json; charset=utf-8 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
scanBillNo | String | 是 | 影像编号 |
deleteReason | String | 否 | 删除单据原因 |
更新影像状态
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /imgsys/bill/outside/scanbill/updateStatus?access_token={ access_token } |
请求参数格式 | Content-Type: application/json; charset=utf-8 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
fscanBillNo | String | 是 | 影像编号 |
fscanStatus | Int | 是 | 影像状态:2-影像已提交完毕(影像提交EAS后) 3-影像审核完成(ERP返回审核通过) 4-影像有误待重扫(影像被打回) |
rejectReason | string | 否 | 退扫原因fscanStatus=4时可传 |
影像驳回(单功能接口)
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /imgsys/bill/outside/reject?access_token={ access_token } |
请求参数格式 | Content-Type: application/json; charset=utf-8 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
scanBillNo | String | 是 | 影像编号 |
rejectReason | string | 是 | 驳回原因 |
撤销影像驳回(单功能接口)
类型 | Post |
---|---|
IP:端口 | baseUrl |
路径 | /imgsys/bill/outside/reject/cancel?access_token={ access_token } |
请求参数格式 | Content-Type: application/json; charset=utf-8 |
字段名称 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
scanBillNo | String | 是 | 影像编号 |
cancelRejectReason | string | 是 | 驳回撤销原因 |
单据审核通过-(单功能接口)
类型 | Post |
---|---|
IP:端口 |