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

1

电子发票签章系统数据规范

2020年05月

2

目录

1.API接口 3

1.1公共请求参数 3

1.2公共返回参数 4

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

1.3.1版式文件生成接口 5

2.Java版本demo 16

2.1HMACSHA256加密签名 16

2.2压缩/解压缩 17

3

1.API接口

1.1公共请求参数

{

interfaceCode:接口编码,

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

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

access_token:身份令牌,

datagram:数据包,

signtype:签名方式,

signature:签名值,

spanId:业务唯一标识

}

数据项

数据项名称

类型

长度

说明

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：使用HMacSHA256算法对

interfaceCode+zipCode+encryptCode+access_t

4

oken+datagram+signtype内容进行字符串拼接后，进行含有密钥散列函数算法，得到结果作为签名值传入，用于平台校验。

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

spanId

业务唯一标识

String

64

透传spanId，用于全链路业务监控，可为空

1.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加解密，参照

5

zipCode与encryptCode字段

signtype

签名方式

String

16

默认为HMacSHA256。

signature

签名值

String

64

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

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

1.3API接口列表及参数说明

序号

接