公共请求参数
API说明:请求报文的公共请求参数
调用方式:HTTP协议
调用方法:json格式
请求报文规范
{
"interfaceCode": "接口编码",
"zipCode": "(0,1 根据数据包大小判断是否进行压缩)",
"encryptCode": "(加密方式,1-3des,2-CA)",
"userName": "用户名",
"access_token": "身份令牌",
"taxpayerId":"企业税号",
"signtype": "签名方式",
"signature": "签名值",
"qqlsh": "发票请求流水号",
"content":"内部报文"
}
字段说明
数据项 | 名称 | 类型 | 长度 | 说明 |
---|---|---|---|---|
interfaceCode | 接口编码 | varchar | 详见:4.1 票据服务API列表 | |
zipCode | 压缩标识 | varchar | 1 | 0:不压缩 1:压缩 (用 GZip 压缩) 企业调用时数据包大于 10k 要求自动压缩; 平台返回时压缩标志为 1 时企业需要自行解 压缩。 |
encryptCode | 加密标识 | varchar | 1 | 1:3DES 密钥由诺e票平台提供。 |
userName | 用户名 | varchar | 由诺e票平台提供。 | |
access_token | 身份令牌 | varchar | 由登录认证服务接口获取 | |
taxpayerId | 纳税人识别号 | varchar | 纳税人识别号 | |
signtype | 签名方式 | varchar | 默认为:HMacSHA256 | |
signature | 签名值 | varchar | 将interfaceCode + zipCode + encryptCode + userName + access_token + taxpayerId + signtype + qqlsh + content的内容拼接后, 进行含有密钥(由诺e票平台提供)的散列函数算法, 得到结果转为大写作为签名值传入,用于平台校验。 |
|
qqlsh | 请求流水号 | varchar | 50 | 请求的流水号,格式为: 税号+8位随机数+yyyymmddhhmmssSSS |
content | 数据包 | varchar | 根据不同的接口,对私有请求报文进行加密 加密流程: BASE64.encode(ZIP 压缩(加密(json 明文))) 解密流程: 解密(ZIP 解压缩(BASE64.decode(json 密 文))) 加解密过程中,是否解压缩及加解密方式,参 照 zipCode 与 encryptCode 字段 |
返回报文规范
{
"code":"错误代码",
"msg":"错误描述",
"interfaceCode": "接口编码",
"zipCode": "(0,1 根据数据包大小判断是否进行压缩)",
"encryptCode": "(加密方式,1-3des)",
"userName": "用户名",
"access_token": "身份令牌",
"taxpayerId":"企业税号",
"signtype": "签名方式",
"signature": "签名值",
"qqlsh": "发票请求流水号",
"content":"内部报文"
}
字段说明
数据项 | 名称 | 类型 | 长度 | 说明 |
---|---|---|---|---|
interfaceCode | 接口编码 | varchar | 详见:4.1 票据服务API列表 | |
zipCode | 压缩标识 | varchar | 1 | 0:不压缩 1:压缩 (用 GZip 压缩) 企业调用时数据包大于 10k 要求自动压缩; 平台返回时压缩标志为 1 时企业需要自行解 压缩。 |
encryptCode | 加密标识 | varchar | 1 | 1:3DES |
userName | 用户名 | varchar | ||
access_token | 身份令牌 | varchar | ||
taxpayerId | 纳税人识别号 | varchar | ||
signtype | 签名方式 | varchar | 默认为:HMacSHA256 | |
signature | 签名值 | varchar | 将interfaceCode + zipCode + encryptCode + userName + access_token + taxpayerId + signtype + qqlsh + content的内容拼接后, 进行含有密钥(由诺e票平台提供)的散列函数算法, 得到结果转为大写作为签名值传入,用于平台校验。 |
|
qqlsh | 请求流水号 | varchar | 50 | 请求的流水号,格式为: 税号+8位随机数+yyyymmddhhmmssSSS |
content | 数据包 | varchar | 根据不同的接口,对私有请求报文进行加密 加密流程: BASE64.encode(ZIP 压缩(加密(json 明文))) 解密流程: 解密(ZIP 解压缩(BASE64.decode(json 密 文))) 加解密过程中,是否解压缩及加解密方式,参 照 zipCode 与 encryptCode 字段 |
|
code | 错误代码 | varchar | 0000:成功 其它:失败 |
|
msg | 错误描述 | varchar | 当 code 不为 0000时,返回错误信息。 |