电子发票交付系统数据规范接口文档 .docx

1

电子发票交付系统数据规范

2019年10月

2

目录

1.API接口 3

1.1公共请求参数 3

2.2公共返回参数 4

2.3API接口列表及参数说明 5

2.3.1电子发票交付接口 5

2.3.2电子发票交付结果查询接口 6

2.Java版本demo 8

2.1HMACSHA256加密签名 8

2.2压缩/解压缩 9

3

1.API接口

1.1公共请求参数

{

interfaceCode:接口编码,

zipCode:(0,1根据数据包大小判断是否进行压缩),

encryptCode:(加密方式代码，2-CA加密),

access_token:身份令牌,

datagram:数据包,

signtype:签名方式,

signature:签名值

}

数据项

数据项名称

类型

长度

说明

interfaceCode

接口编码

String

不同接口编码不一样，详见下面接口列表

zipCode

压缩标识

String

1

0：不压缩1：压缩(用GZip压缩)

企业调用时数据包大于10k要求自动压缩，并置为1，否则为0；

平台返回时压缩标志为1时企业需要自行解

压缩，为0时不需要解压缩。

encryptCode

加密标识

String

1

2:CA加密

access_token

身份令牌

String

datagram

数据包

String

根据不同的接口，对私有请求报文进行加密加密流程：

BASE64.encode(ZIP压缩(CA加密(json明文)))解密流程：

CA解密(ZIP解压缩(BASE64.decode(json密

文)))

加解密过程中，是否解压缩与CA加解密，参照zipCode与encryptCode字段

signtype

签名方式

String

16

默认为HMacSHA256。

signature

签名值

String

64

根据signtype不同使用不同的签名方式：1、HMacSHA256：对上述全部字段，从

interfaceCode开始，按照先后顺序做字符串

4

拼接，使用HMacSHA256进行含有密钥散列函数算法，得到结果作为签名值传入，用于平台校验。

使用调用方的注册码作为密钥。

2.2公共返回参数

{

code:错误代码,

msg:错误描述,

interfaceCode:接口编码,

zipCode:(0,1根据数据包大小判断是否进行压缩),

encryptCode:(加密方式代码，2-CA加密),

access_token:身份令牌,

datagram:数据包,

signtype:签名方式,

signature:签名值

}

数据项

数据项名称

类型

长度

说明

code

错误代码

Int

1000-成功，其他-失败

msg

错误描述

String

当code不为1000时，说明错误信息

interfaceCode

接口编码

String

zipCode

压缩标识

String

1

0：不压缩1：压缩(用GZip压缩)

企业调用时数据包大于10k要求自动压缩，并置为1，否则为0；

平台返回时压缩标志为1时企业需要自行解压

缩，为0时不需要解压缩。

encryptCode

加密标识

String

1

2:CA加密

access_token

身份令牌

String

datagram

数据包

String

根据不同的接口，对私有请求报文进行加密加密流程：

BASE64.encode(ZIP压缩(CA加密(json明文)))解密流程：

CA解密(ZIP解压缩(BASE64.decode(json密文)))加解密过程中，是否解压缩与CA加解密，参照zipCode与encryptCode字段

5

signtype

签名方式

String

16

默认为HMacSHA256。

signature

签名值

String

64

根据signtype不同使用不同的签名方式：1、HMacSHA256：对上述全部字段，从interfaceCode开始，按照先后顺序做字符串拼接，使用HMacSHA256进行含有密钥散列函数算法，得到结果作为签名值传入，用于平台校验。

使用调用方的注册码作为密钥。

2.3API接口列表及参数说明

序号

接口编码

接口名称

说明

实现

1

51.invoice.deliver

电子发票交付接口

2

51.invoice.deliver.query

电子发票交付结果查询接口

2.