财政国库电子支付电子凭证库接口说明043000.docx

1、财政国库电子支付电子凭证库接口说明043000财政国库电子支付电子凭证库接口说明 广州江南科友科技股份有限公司2013年03月修订版历史日期和代码版本版本说明作者2012-7-30EVoucher2012-09-30-001.0初稿曾明军2012-11-13EVoucher2012-09-30-021.1客户端：1. （新增）清除U-KEY缓存ClearPinCache2. （新增）客服端不带位置签名signWithoutPosition3. （新增）验证不带位置的签名verfiySignWithoutPosition服务端：1. （新增）服务器端不带位置签名signWithoutPositi

2、on2. （新增）验证不带位置的签名verfiySignWithoutPosition3. （新增）查询日志信息接口queryVoucherLogs4. （新增）批量查询凭证发送状态batchQuerySentVoucherStatus5. （新增）业务系统与凭证库对账getVoucherStatement6. （新增）撤销不带位置签名cancelSignWithoutPosition雷瑞恒2012-11-30EVoucher2012-09-30-03服务端：1. （新增）发送全版本凭证sendVoucherFullSigns2. （新增）批量查询发送凭证状态batchQuerySentVou

3、cherStatus2013-03-19EVoucher2013-04-30-002.0客户端：1. （新增）选择印章SelectStampId2. （新增）异常捕获GetLastErr3. （新增）获取证书接口DlgSelectCertId服务端：1. （新增）查询凭证盖章列表queryVoucherSignStampPositions2. （新增）指定日期读取凭证readVoucherByDate3. （新增）发起消息对账startMsgStatement4. （新增）查询消息对账凭证列表queryMsgStatementVoucherNos5. （新增）指定凭证号查询消息对账单query

4、MsgStatementByVoucherNo6. （新增）查询错误的消息对账凭证列表queryErrorMsgStatementVoucherNos7. （新增）重发消息reSendMessage其他:调整部分接口与代码参数不匹配，更新服务端异常代码2013-04-30-00EVoucher2013-06-15-003.0服务端：1. （新增）业务系统之间数据请求功能requestData2. （新增）业务系统之间数据发送sendData3. （新增）获取数据getData4. （新增）指定机构查询凭证状态queryVoucherStatusByOrgType5. （新增）查询凭证库被篡改的

5、电子凭证 queryTamperedVoucherNOs2013-06-15EVoucher2013-06-15-03客户端：1、（新增）验证Ukey Pin码接口VerifyPin2、（新增）获取当前选择证书的CN接口 GetCurCertCN林因2013-10-30EVoucher2013-12-30-004.0服务端:1、（新增）指定日期查询被退回凭证readReturnVoucherByDate2、（新增）批量查询被退回的凭证号batchQueryVoucherNosByBackStatus客户端：1、（新增）获取操作人证书列表 GetOperatorCertsList雷瑞恒2014-

6、5-20EVoucher2014-04-30-005.0服务端:1、（新增）获取签章、签名中的SN、DN getSnInfo林因1 电子凭证库接口说明财政国库无纸化支撑系统（简称：无纸化支撑系统）需要支持财政与人行(商业银行)交互电子凭证数据全流程管理，主要包括：1、对全流程电子凭证进行凭证分类、签名、验签、签章及验章操作，并支持全流程电子数据版本化管理。2、实现财政与人行和商业银行系统间进行电子凭证数据的安全传输。为了简化业务系统实现以上需求，无纸化支撑系统将业务系统对电子凭证的管理进行分析整理后，归纳出对电子凭证库的接口需求，分为电子凭证库客户端接口和电子凭证库服务端接口两大类：1、 电子

7、凭证库客户端接口主要提供凭证盖章、查看及打印可视化的操作。2、 电子服务端接口主要提供凭证保存及发送等后台操作。以下分客户端接口和服务端接口分别阐述相关接口，并提供部分调用示例供财政、人行、商业银行业务系统参考开发。2 电子凭证库客户端接口本章节描述了电子凭证库客户端的接口，调用方式采用ocx调用。调用接口异常时，需要调用GetLastErr接口获取异常信息并反馈给前端用户。2.1 设置电子凭证服务地址2.1.1 功能说明设置电子凭证服务地址，用于与电子凭证服务器通讯。 电子凭证库客户端为简化业务系统调用的步骤，封装了如获取电子凭证模板、根据凭证号读取凭证等共用的查询操作，而此类操作需要电子凭

8、证库客户端根据业务系统设置的地址访问电子凭证库服务。业务系统调用电子凭证库客户端时，第一步应设置电子凭证库与电子印章的服务地址。由于业务系统的客户端所处的网段不同，在设置电子凭证库与电子印章服务地址时需要根据IP地址适配。若业务系统客户端IP地址为外网网段，应设置电子凭证库与电子印章服务的外网地址；若业务系统客户端IP地址为内网网段，应设置电子凭证库与电子印章服务的内网地址；2.1.2 函数名int SetEvoucherServiceUrl (String url);2.1.3 输入参数序号英文名数据类型参数说明1urlString电子凭证服务器urlhttp:/地址:端口/realware

9、/services/OCXService?wsdl2.1.4 输出序号英文名数据类型参数说明1Int0成功、大于0错误编码2.1.5 代码示例String evoucherUrl =null;/电子凭证库服务地址String estampUrl =null;/电子印章服务地址Int a=0;/返回结果/读取业务系统客户端IP地址，并根据网段判断IP地址是内外网boolean isInner=this. decisionNetwork(客户端IP);If(isInner)/客户端为内网地址,获取电子凭证库与电子印章内网地址evoucherUrl =this.getInnerEVoucherUrl

10、();estampUrl =this. getInnerEStampUrl();else/客户端为外网地址,获取电子凭证库与电子印章外网地址evoucherUrl =this.getOuterEVoucherUrl();estampUrl =this. getOuterEStampUrl();/设置电子凭证库服务地址a=OCX. SetEvoucherServiceUrl(evoucherUrl);if(a!=0)throw new RuntimeException(“初始化电子凭证库服务地址失败,”+ OCX. GetLastErr();/设置电子印章服务地址a= OCX. SetEstam

11、pServiceUrl (estampUrl);if(a!=0)throw new RuntimeException(“初始化电子印章库服务地址失败,”+ OCX. GetLastErr();/ OCX初始化/ OCX其他操作2.2 设置电子印章服务地址2.2.1 功能说明设置电子印章服务器地址，用于与电子印章服务器通讯。电子凭证库客户端签章与验章操作都需要访问电子印章服务，若通过电子凭证库服务访问电子印章，大大的降低了客户端签章与验章的性能。采用电子凭证库客户端直连电子印章服务的模式使签章、验章更加的高效。2.2.2 函数名int SetEstampServiceUrl (String ur

12、l);2.2.3 输入参数序号英文名数据类型参数说明1urlString电子印章服务器url吉大印章：http:/地址:端口科友印章：http:/地址:端口/realware/services/AsspEStampService2.2.4 输出序号英文名数据类型参数说明1Int0成功、大于0错误编码2.3 生成电子签章报文2.3.1 功能说明业务系统客户端调用此接口生成电子签章结果报文传至服务端，再由业务系统服务端调用电子凭证服务接口“写入客户端签章的凭证”保存电子凭证，完成客户端电子签章操作。客户端签章依赖UKEY，电子印章类型分为公章与私章两类。私章烧制入UKEY,公章需要与UKEY的证书

13、绑定。2.3.2 函数名String GetVoucherStamp(String certID, String admDivCode, int stYear, String vtCode, String stamp, String voucherXML)2.3.3 输入参数序号英文名数据类型参数说明1certIDString用户证书ID(登录用户证书id)2admDivCodeString行政区划，最大长度15位3stYearint业务年度，4位数字，20124vtCodeString凭证类型，4位字符，参见报文规范5stampString位置信息凭证签名(章)位置报文6voucherXML

14、String客户端待签名 (章)凭证报文2.3.4 输出参数序号英文名数据类型参数说明1String凭证签名(章)结果报文2.4 生成电子签名报文2.4.1 功能说明业务系统客户端调用此接口获取电子签名结果报文传至服务端，再由业务系统服务端调用电子凭证服务接口“写入客户端签名的凭证”保存电子凭证，完成客户端电子签名操作。2.4.2 函数名String GetVoucherSign(string certID, string admDivCode, int stYear, string vtCode, string certInfo,string voucherXML );2.4.3 输入参数序

15、号英文名数据类型参数说明1certIDString用户证书ID(登录用户证书id)2admDivCodeString行政区划，最大长度15位3stYearint业务年度，4位数字，20124vtCodeString凭证类型，4位字符，参见报文规范5certInfoString凭证签名(章)位置报文6voucherXMLString客户端待签名 (章)凭证报文2.4.4 输出参数序号英文名数据类型参数说明1String凭证签名(章)结果报文（NULL或者长度为0，表示失败）2.5 凭证显示控件（OCX）查询打印控件用于实现对电子凭证的可视化显示打印。包括控件初始化、加载凭证和设置需要显示的凭证3

16、个主要接口；加载凭证：增加不带报文的接口。辅助接口包括凭证打印接口。2.5.1 初始化2.5.1.1 功能说明用于初始化显示控件，从电子凭证服务端加载电子凭证的模板。2.5.1.2 函数名int Initialize(String certID, String admDivCode, int stYear, String vtCode, String reserver1, int displayMode, int ParamValue, int defaultPage);2.5.1.3 输入参数：序号英文名数据类型参数说明1certIDString用户证书ID(登录用户证书id)2admDiv

17、CodeString行政区划，最大长度15位3stYearint业务年度，4位数字4vtCodeString凭证类型，4位字符，参见报文规范5reserver1 String保留参数，传入”0”6displayModeint显示模式：1.列表模式 2.单页模式7ParamValueint列表模式下的显示行列数：（输入2即为2行2列显示）8defaultPageint默认显示页（联）（最好默认为0）2.5.1.4 输出参数：序号英文名数据类型参数说明1Int0成功、大于0错误编码2.5.2 加载电子凭证2.5.2.1 功能说明添加要显示凭证信息用于客户端程序，调用此方法添加需要显示的签章凭证信息

18、，逐笔添加。 2.5.2.2 函数名int AddVoucher( String voucherNo, String xmlBody);2.5.2.3 输入参数序号英文名数据类型参数说明1voucherNoString凭证编号2xmlBodyString需要显示的凭证信息，具体格式参考：电子支付安全支撑控件电子凭证报文规范2.5.2.4 输出参数序号英文名数据类型参数说明1int0成功、大于0错误编码2.5.3 指定凭证号加载电子凭证2.5.3.1 功能说明不带报文的接口，接口自动从服务器加载凭证对于回单不做全版本验证（只验证最新数据的完整性），显示时加载回单的原文进行展现。2.5.3.2 函

19、数名int AddVoucherfromServer(String voucherNo); 2.5.3.3 输入参数序号英文名数据类型参数说明1voucherNoString凭证单号2.5.3.4 输出参数序号英文名数据类型参数说明1int0成功、大于0错误编码2.5.4 指定原文加载电子凭证2.5.4.1 功能说明可将从后台下载的凭证（调用后台readVoucherAgain得到的报文）直接加载到OCX中。2.5.4.2 函数名int AddVoucherXmls(String XmlVouchers, int bUpdatefromVoucher);2.5.4.3 输入参数序号英文名数据类

20、型参数说明1XmlVouchersString凭证原文,具体格式参考：电子支付安全支撑控件电子凭证报文规范2bUpdatefromVoucherint是否从凭证库重新加载凭证，1代表是，0代表否2.5.4.4 输出参数序号英文名数据类型参数说明1int0成功、大于0错误编码2.5.5 显示指定的凭证（凭证编号） 2.5.5.1 功能说明定位到显示的凭证，OCX自动验签（章），取章显示。2.5.5.2 函数名int SetCurrentVoucher (String voucherNo);2.5.5.3 输入参数序号英文名数据类型参数说明1voucherNOString凭证号2.5.5.4 输出

21、参数序号英文名数据类型参数说明1Int0成功、大于0错误编码2.5.6 显示指定的凭证（凭证索引） 2.5.6.1 功能说明：本接口已不推荐使用。定位到显示的凭证，OCX自动验签（章），取章显示。2.5.6.2 函数名int displayVoucherByIndex(int voucherIndex);2.5.6.3 输入参数序号英文名数据类型参数说明1voucherIndexint凭证索引（索引号从0开始）2.5.6.4 输出参数序号英文名数据类型参数说明1Int0成功大于0失败2.5.7 打印凭证（凭证号）2.5.7.1 功能说明打印加载到显示控件的凭证。2.5.7.2 函数名int P

22、rintVoucherByNo(String voucherNo, int pageNo);2.5.7.3 输入参数序号英文名数据类型参数说明1voucherNoString凭证编号2pageNoint凭证联2.5.7.4 输出参数序号英文名数据类型参数说明1Int0成功大于0失败2.5.8 打印凭证（按凭证索引号）2.5.8.1 功能说明打印加载到显示控件的凭证。2.5.8.2 函数名Int PrintVoucherByIndex(int voucherIndex, int pageNo);2.5.8.3 输入参数序号英文名数据类型参数说明1voucherIndexint凭证索引2pageN

23、oint凭证联2.5.8.4 输出参数序号英文名数据类型参数说明1Int0成功大于0失败2.5.9 打印凭证（按索引范围批量打印）2.5.9.1 功能说明打印加载到显示控件的凭证。2.5.9.2 函数名int PrintVoucherByIndexRange(int beginIndex, int endIndex int pageNo);2.5.9.3 输入参数序号英文名数据类型参数说明1beginIndexint起始凭证索引2endIndexint结束凭证索引3pageNoint凭证联2.5.9.4 输出参数序号英文名数据类型参数说明1Int0成功大于0失败2.5.10 打印当前显示的凭证

24、2.5.10.1 功能说明打印当前ocx中显示的凭证2.5.10.2 函数名int PrintCurrentVoucher(int bShowPrintSettingDialog)2.5.10.3 输入参数序号英文名数据类型参数说明1bShowPrintSettingDialogInt是否显示打印提示框，1代表是，0代表否2.5.10.4 输出参数序号英文名数据类型参数说明1Int0成功大于0失败2.5.11 清空凭证列表2.5.11.1 功能说明清除控件中的数据，保留模板。2.5.11.2 函数名void ResetContent();2.5.12 移除指定凭证（凭证编号）2.5.12.1

25、功能说明删除控件中某笔凭证数据。2.5.12.2 函数名int removeVoucherByNo(String VoucherNo );2.5.12.3 输入参数序号英文名数据类型参数说明1voucherNoString凭证编号2.5.12.4 输出参数序号英文名数据类型参数说明1Int0成功大于0失败2.5.13 移除指定凭证（凭证索引）2.5.13.1 功能说明删除控件中某笔凭证数据。2.5.13.2 函数名int removeVoucherByIndex(int voucherIndex );2.5.13.3 输入参数序号英文名数据类型参数说明1voucherIndexint凭证索引2

26、.5.13.4 输出参数序号英文名数据类型参数说明1int0成功大于0失败2.5.14 查看凭证的上一联2.5.14.1 功能说明实现查看凭证的上一联。2.5.14.2 函数名 int PageUp (void); 2.5.14.3 输出参数序号英文名数据类型参数说明1Int0成功大于0失败2.5.15 查看凭证下一联2.5.15.1 功能说明 实现查看凭证下一联2.5.15.2 函数名 int PageDown (void);2.5.15.3 输出参数序号英文名数据类型参数说明1Int0成功大于0失败2.5.16 获取凭证联数2.5.16.1 功能说明获取凭证总联数2.5.16.2 函数名i

27、nt GetPageCount (void);2.5.16.3 输出参数序号英文名数据类型参数说明1int联数2.5.17 获取加载的凭证总数2.5.17.1 功能说明获取当前OCX已加载的凭证总数2.5.17.2 函数名int GetVoucherCount(void)2.5.17.3 输入参数无2.5.17.4 输出参数 序号英文名数据类型参数说明1int凭证总数2.5.18 显示下一条凭证2.5.18.1 功能说明跳转显示OCX缓存中的下一条凭证2.5.18.2 函数名int GotoNextVoucher(void)2.5.18.3 输入参数无2.5.18.4 输出参数序号英文名数据类型参数说明1Int0成功大于0失败2.5.19 显示上一条凭证2.5.19.1 功能说明跳转显示OCX缓存中的上一条凭证2.5.19.2 函数名int GotoPrevVoucher(void)2.5.19.3 输入参数无2.5.19.4 输出参数序号英文名数据类型参数说明1Int0成功大于0失