财政电子票据公共服务接口规范.docx

财政电子票据公共服务接口规范适用范围本规范规定了财政电子票据公共服务接口,为财政电子票据服务平台和外部系统间在交互财政电子票据相关电子信息时的接口技术规范,实现财政电子票据的下载和入账反馈。技术规范处理流程使用公共服务接口时,基于HTTPS协议,采用POST方式“请求-响应”模式进行交互。(1)请求方发送请求请求方系统由财政电子票据服务平台分配一个身份标识app_id,每个app_id配有一个秘钥(appKey)。请求方根据接口要求,构造请求参数并使用密钥(appKey)对请求参数进行签名。(2)电子票据服务平台返回响应结果电子票据服务平台通过验证请求参数的签名来验证请求方身份合法性及数据完整性,无误后进行处理。处理成功时,根据请求服务不同,响应结果分为两种情况:电子票据下载时,返回电子票据文件压缩包;电子票据入账时,返回JSON格式的参数。处理失败时,响应结果为JSON格式的参数。(3)请求方接收数据请求方收到响应结果后,首先判断电子票据服务平台响应是否成功:电子票据下载时,通过HTTPContent-Type判断是否成功;电子票据入账时,通过返回码判断是否成功。数据类型序号类型类型名称说明1String字符串标准XML字符串类型(xs:string)。长度分为定长和变长两种,例如:长度“8”表示字符串长度固定为8,长度“[1,100]”表示字符串长度在1到100之间2NString数字串表示由数字0-9组成的字符串,如:3Integer整数标准XML整数类型(xs:integer)4Decimal实数标准XML实数类型(xs:decimal)5Base64BinaryBase64编码字符串标准XMLBase64编码字符串类型(xs:base64Binary)6Date日期表示日期,格式为yyyyMMdd(年月日),长度为8位,如:7Time时间表示时间,格式为HH:mm:ss(时分秒),长度为8位,如:09:29:538DateTime日期时间表示日期时间,格式为yyyyMMddHH:mm:ss(年月日时分秒),长度为17位,如:09:29:539UTCDateTimeUTC日期时间表示UTC日期时间,格式为ddMMMyyyyHH:mm:ssz(日月年时分秒时区),长度为24位,如:13Jun201609:29:53GMT10Currency金额表示金额,单位为元,整数部分最长15位,小数部分固定两位,不能包含逗号等分隔符,如:。是4formatString定义请求参数message和接口返回的数据格式。取值说明:json是5datetimeDateTime时间,格式为yyyyMMddHHmmssSSS是6version版本NString5接口版本,[1,50]每次请求生成一个唯一请求编号是8message请求业务参数String请求业务参数,参见具体接口描述。需转换为Base64编码。说明:(1)参数名必须为小写字母;(2)业务参数message的构成,根据具体接口描述构造;(3)字符集统一采用UTF