接口开发手册 .pdf
《接口开发手册 .pdf》由会员分享,可在线阅读,更多相关《接口开发手册 .pdf(37页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、1 养老保险待遇状态比对查询服务系统接口开发手册(1.0 版)2011.7.25 名师资料总结-精品资料欢迎下载-名师精心整理-第 1 页,共 37 页 -2 目录1 接口 API使用说明 .11.1 接口 API概述 .12 JAVA接口使用说明.12.1 JAVA接口类列表 .12.2 Java接口 API 说明.22.2.1 上传.22.2.1.1 FileUploadAgent.22.2.1.2 FileUploadParams.32.2.1.3 FileUploadResponse.62.2.2 通用查询.72.2.2.1 CommQueryAgent.72.2.2.2 CommQu
2、eryResponse.92.2.3 错误文件下载.11 2.2.3.1 ErrFileDownloadAgent.11 2.2.3.2 ErrFileDownloadParams.12 2.2.3.3 ErrFileDownloadResponse.14 2.2.4 证书有效期查询.16 2.2.4.1 CertQueryAgent.16 2.3 Java接口开发举例 .16 2.3.1 领取人员批量查询.16 2.3.1.1 领取人员批量查询上传.16 2.3.1.2 通用查询(查询领取待遇人员批量查询结果).17 2.3.1.3 错误文件列表查询.17 2.3.1.4 错误文件下载.18
3、 3 C接口使用说明.19 3.1 C接口 API说明 .19 3.1.1 上传.19 3.1.1.1 FileUploadAgentInit.19 3.1.1.2 SetFileUploadParams.19 3.1.1.3 FileUploadSendAndReceive.20 3.1.1.4 GetFileUploadResponse.20 3.1.1.5 FileUploadAgentEnd.21 3.1.2 通用查询.21 3.1.2.1 CommQueryAgentInit.21 3.1.2.2 SetCommQueryParams.21 3.1.2.3 CommQuerySend
4、AndReceive.22 3.1.2.4 GetCommQueryResponse.22 3.1.2.5 CommQueryAgentEnd.23 3.1.3 错误文件下载.23 3.1.3.1 ErrFileDownloadAgentInit.23 名师资料总结-精品资料欢迎下载-名师精心整理-第 2 页,共 37 页 -3 3.1.3.2 setErrFileDownloadParams.23 3.1.3.3 ErrFileDownloadSendAndReceive.24 3.1.3.4 GetErrFileDownloadResponse.24 3.1.3.5 ErrFileDown
5、loadAgentEnd.25 3.1.4 证书有效期查询.25 3.1.4.1 GetCertPeriod.25 附录 1 比对查询系统反馈的错误代码列表.1附录 2:接口反馈代码.2附录 3:查询条件列表.6附录 4:开发常见问题及解答.8名师资料总结-精品资料欢迎下载-名师精心整理-第 3 页,共 37 页 -1 1 接口 API使用说明1.1 接口 API 概述在采用嵌入式或前置系统接入模式下,基于本手册进行本地后台接口的开发。比对查询业务接口API 提供了基于Java 和 C语言的两种接口封装形式,各地可根据本地业务管理系统的开发环境选用。Java 接口采用Jar包形式,C 语言采用
6、动态链接库dll形式并提供开发需要的.h 头文件和.lib库文件。在实际的运行环境中,需要将 jar或者 dll文件部署到使用比对查询业务接口的系统库文件目录内,部署接口 api 的服务器必须能够通过网络直接访问部级养老保险待遇状态比对查询服务系统进行数据交换,同时由于接口会自动对传输的数据进行数字签名,需要在此服务器上部署安装金保工程统一的设备数字证书以及相关认证软件包。2 JAVA接口使用说明2.1 JAVA接口类列表接口名称接口描述FileUploadAgent 文件上传代理FileUploadParams 上传文件参数对象FileUploadResponse 上传文件结果返回对象Com
7、mQueryAgent 通用查询代理CommQueryResponse 通用查询返回对象ErrFileDownloadAgent 下载错误文件代理ErrFileDownloadParams 下载错误文件参数对象ErrFileDownloadResponse 下载错误结果返回对象CertQueryAgent 查询证书有效期对象名师资料总结-精品资料欢迎下载-名师精心整理-第 4 页,共 37 页 -2 2.2 Java 接口 API 说明Jar 包名称:sitrb.jar 依赖包:Axis 1.4 开发环境要求:支持Eclipse等各类 Java 开发工具,J2SE1.4 及以上版本。运行环境要
8、求:JRE1.4 以及上版本,可以部署在J2EE容器内运行。2.2.1 上传2.2.1.1 FileUploadAgent 上传文件代理类,上传文件时调用此类。构造方法摘要FileUploadAgent()初始化一个建新的FileUploadAgent 对象。方法摘要FileUploadResponse sendAndReceive(FileUploadParams upParams)将请求信息发送给服务器,并返回一个FileUploadResponse 对象。构造方法详细信息2.2.1.1.1FileUploadAgent public FileUploadAgnet()初始化一个新建的Fi
9、leUploadAgent 对象。方法详细信息2.2.1.1.2sendAndReceive public FileUploadResponse sendAndReceive(FileUploadParams upParams)名师资料总结-精品资料欢迎下载-名师精心整理-第 5 页,共 37 页 -3 将请求信息发送给服务器,并返回一个FileUploadResponse 对象。参数:upParams上传文件参数对象。返回:FileUploadResponse 上传文件结果返回对象。2.2.1.2 FileUploadParams 上传文件参数类,用于传入上传文件请求的各种参数。构造方法摘要
10、FileUploadParams()初始化一个建新的FileUploadParams 对象。方法摘要void setOrgID(String orgID)传入组织机构代码void setBuzzType(String transType)传入业务数据分类标识void setSendType(String upType)传入上传方式,1-以文件方式上传;2-以流方式上传void setUploadFileName(String uploadFileName)传入上传文件的文件名。void setUploadStream(String stream)传入待上传字符流。以文件方式上传时不需传入该值。
11、void setCertType(String certType)传入证书类型。public void setXzscope(String xzScope)上传文件所属险种,必须是具体一个险种类型,如 110、120、150。构造方法详细信息名师资料总结-精品资料欢迎下载-名师精心整理-第 6 页,共 37 页 -4 2.2.1.2.1FileUploadParams public FileUploadParams()初始化一个新建的FileUploadParams 对象。方法详细信息2.2.1.2.2setBuzzType public void setBuzzType(String buz
12、zType)传入本次上传的交易类型。参数:buzzType本次上传的业务类型代码。返回:无。2.2.1.2.3setDataFileType public void setDataFileType(String dataFileType)传入数据文件类型。参数:dataFileType 数据文件类型。1TXT文件。返回:无。2.2.1.2.4setSendType public void setSendType(String sendType)传入上传方式。参数:sendType 上传方式,1-以文件方式上传。2-以流方式上传。返回:无。2.2.1.2.5setFileDate public
13、void setFileDate(String sendDate)传入文件生成日期。名师资料总结-精品资料欢迎下载-名师精心整理-第 7 页,共 37 页 -5 参数:fileDate 文件生成日期,格式为YYYYMMDD。返回:无。2.2.1.2.6setUploadFileName public void setUploadFileName(String uploadFileName)传入上传文件的文件名。参数:uploadFileName 文件名。返回:无。2.2.1.2.7setUploadStream public void setUploadStream(String stream
14、)传入待上传字符流。参数:stream 待上传字符流,当上传方式为文件方式时返回值无意义。返回:无。2.2.1.2.8setCertType public void setCertType(String certType)传入证书类型。参数:certType 证书类型。2设备证书。返回:无。2.2.1.2.9setXzscope public void setXzscope(String xzScope)传入险种类型。参数:xzScope,险种类型:110城镇企业职工基本养老保险,120机关事业单位养老保险,150新型农村社会养老保险,160城镇居民社会养老保险,170城乡居民社会养老保险。返
15、回:无。名师资料总结-精品资料欢迎下载-名师精心整理-第 8 页,共 37 页 -6 2.2.1.3 FileUploadResponse 上传结果返回对象,返回上传文件处理是否成功标志及处理信息。构造方法摘要FileUploadResponse()初始化一个建新的FileUploadResponse 对象。方法摘要String getErrorFlag()获取上传文件处理是否成功标志。String getRetMsg()获取上传文件处理结果信息。String getStackStrace()获取查询操作的错误堆栈构造方法详细信息2.2.1.3.1FileUploadResponse publ
16、ic FileUploadResponse()初始化一个新建的FileUploadResponse 对象。方法详细信息2.2.1.3.2getErrorFlag public String getErrorFlag()获取上传文件处理是否成功标志。参数:无。返回:String 是否成功标志。0成功,非0失败(具体类型参见错误类型列表)2.2.1.3.3getRetMsg public String getRetMsg()获取上传文件处理结果信息。名师资料总结-精品资料欢迎下载-名师精心整理-第 9 页,共 37 页 -7 参数:无。返回:String 上传文件处理结果信息。2.2.1.3.4g
17、etStackTrace public String getStackTrace()获取上传操作的错误堆栈。参数:无。返回:String 上传操作的错误堆栈。2.2.2 通用查询2.2.2.1 CommQueryAgent 通用查询代理类,向后台发送各类业务查询请求,后台业务程序按约定格式返回查询结果。构造方法摘要CommQueryAgent()初始化一个建新的CommQueryAgent 对象。方法摘要void setOrgID(String orgID)传入组织机构代码String setCertType (String certType)传入证书类型。void setBuzztype(S
18、tring FuncID)传入查询请求业务类型。void setQueryParams(Hashmap params)传入查询请求参数。不同的业务查询所需要的参数不尽相同,具体业务查询参数详见接口功能说明部分。String query()将请求信息发送给服务器,查询业务数据,业务程序按约定格式返回结果字符串,具体格式参见数据传输封装规范。public void setXzscope(String 查询所属险种,具体一个险种类型,如110、120、150。对应上传文件的险种类型。名师资料总结-精品资料欢迎下载-名师精心整理-第 10 页,共 37 页 -8 xzScope)构造方法详细信息2.2
19、.2.1.1CommQueryAgent public CommQueryAgent()初始化一个新建的CommQueryAgent对象。方法详细信息2.2.2.1.2setBuzzType public void setBuzzType(String Buzztype)传入查询业务类型,具体类型对应业务详见接口功能列表。参数:BuzzType 查询请求业务类型返回:无。2.2.2.1.3setDataFileType public void setDataFileType(String dataFileType)传入数据文件类型。参数:dataFileType 数据文件类型。1TXT文件。返
20、回:无。2.2.2.1.4setCertType public void setCertType(String certType)传入证书类型。参数:certType 证书类型。”2”设备证书返回:无。名师资料总结-精品资料欢迎下载-名师精心整理-第 11 页,共 37 页 -9 2.2.2.1.5setQueryParam public void setQueryParam(Hashmap params)传入查询参数。参数:params查询参数,不同的查询业务所需要的参数不尽相同,全部为 String 类型,具体参数详见接口功能列表。返回:无。2.2.2.1.6query public Co
21、mmQueryResponse query()将查询请求发送到服务器,查询业务数据,业务程序按约定格式返回结果字符串,具体格式参见数据传输封装模范。参数:无返回:CommQueryResponse 返回的查询数据。2.2.2.1.7setXzscope public void setXzscope(String xzScope)传入险种类型。参数:xzScope,险种类型:110城镇企业职工基本养老保险,120机关事业单位养老保险,150新型农村社会养老保险,160城镇居民社会养老保险,170城乡居民社会养老保险。返回:无。2.2.2.2 CommQueryResponse 查询结果返回对象,
22、返回下载文件处理是否成功标志,查询得到的信息和文件名。构造方法摘要CommQueryResponse()初始化一个建新的FileDownloadResponse 对象。名师资料总结-精品资料欢迎下载-名师精心整理-第 12 页,共 37 页 -10 方法摘要String getErrorFlag()获取查询是否成功标志。String getRetMsg()获取查询结果信息。String getStackStrace()获取查询操作的错误堆栈String getDownFileName()获取查询结果的文件名称。String getDownStream()获取查询结果。构造方法详细信息2.2.2
23、.2.1CommQueryResponse public FileDownloadResponse()初始化一个新建的FileDownloadResponse 对象。方法详细信息2.2.2.2.2getErrorFlag public String getErrorFlag()获取下载文件处理是否成功标志。参数:无。返回:String 是否成功标志。0成功,非0失败(具体类型参见错误类型列表)2.2.2.2.3getRetMsg public String getRetMsg()获取下载文件处理结果信息。参数:无。返回:String 下载文件处理结果信息。名师资料总结-精品资料欢迎下载-名师精
24、心整理-第 13 页,共 37 页 -11 2.2.2.2.4getDownFileName public String getDownFileName()获取下载后的文件名称。参数:无。返回:String 下载后的文件名称。2.2.2.2.5getStackTrace public String getStackTrace()获取上传文件处理结果信息。参数:无。返回:String 上传操作的错误堆栈。2.2.2.2.6getDownStream public String getDownStream()获取下载的字符流。参数:无。返回:String 下载的字符流。2.2.3 错误文件下载2.
25、2.3.1 ErrFileDownloadAgent 错误文件下载代理类,下载错误文件时调用此类。构造方法摘要ErrorFileDownloadAgent()初始化一个建新的ErrorFileDownloadAgent对象。名师资料总结-精品资料欢迎下载-名师精心整理-第 14 页,共 37 页 -12 方法摘要FileDownloadResponse sendAndDownloadErrFile(ErrFileDownloadParams errDownParams)将下载错误文件的请求参数发送给服务器,下载错误文件,并返回一个 FileDownloadResponse 对象。public
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 接口开发手册 2022 接口 开发 手册
限制150内