接口开发手册.docx
《接口开发手册.docx》由会员分享，可在线阅读，更多相关《接口开发手册.docx（40页珍藏版）》请在冰豆网上搜索。
接口开发手册
养老保险待遇状态比对查询服务系统
接口开发手册
（1.0版）
2011.7.25
目录
1接口API使用说明1
1.1接口API概述1
2JAVA接口使用说明1
2.1JAVA接口类列表1
2.2Java接口API说明2
2.2.1上传2
2.2.1.1FileUploadAgent2
2.2.1.2FileUploadParams3
2.2.1.3FileUploadResponse6
2.2.2通用查询7
2.2.2.1CommQueryAgent7
2.2.2.2CommQueryResponse9
2.2.3错误文件下载11
2.2.3.1ErrFileDownloadAgent11
2.2.3.2ErrFileDownloadParams12
2.2.3.3ErrFileDownloadResponse14
2.2.4证书有效期查询16
2.2.4.1CertQueryAgent16
2.3Java接口开发举例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
3C接口使用说明19
3.1C接口API说明19
3.1.1上传19
3.1.1.1FileUploadAgentInit19
3.1.1.2SetFileUploadParams19
3.1.1.3FileUploadSendAndReceive20
3.1.1.4GetFileUploadResponse20
3.1.1.5FileUploadAgentEnd21
3.1.2通用查询21
3.1.2.1CommQueryAgentInit21
3.1.2.2SetCommQueryParams21
3.1.2.3CommQuerySendAndReceive22
3.1.2.4GetCommQueryResponse22
3.1.2.5CommQueryAgentEnd23
3.1.3错误文件下载23
3.1.3.1ErrFileDownloadAgentInit23
3.1.3.2setErrFileDownloadParams23
3.1.3.3ErrFileDownloadSendAndReceive24
3.1.3.4GetErrFileDownloadResponse24
3.1.3.5ErrFileDownloadAgentEnd25
3.1.4证书有效期查询25
3.1.4.1GetCertPeriod25
附录1比对查询系统反馈的错误代码列表1
附录2：
接口反馈代码2
附录3：
查询条件列表6
附录4：
开发常见问题及解答8
1接口API使用说明
1.1接口API概述
在采用嵌入式或前置系统接入模式下，基于本手册进行本地后台接口的开发。
比对查询业务接口API提供了基于Java和C语言的两种接口封装形式，各地可根据本地业务管理系统的开发环境选用。
Java接口采用Jar包形式，C语言采用动态链接库dll形式并提供开发需要的.h头文件和.lib库文件。
在实际的运行环境中，需要将jar或者dll文件部署到使用比对查询业务接口的系统库文件目录内，部署接口api的服务器必须能够通过网络直接访问部级养老保险待遇状态比对查询服务系统进行数据交换，同时由于接口会自动对传输的数据进行数字签名，需要在此服务器上部署安装金保工程统一的设备数字证书以及相关认证软件包。
2JAVA接口使用说明
2.1JAVA接口类列表
接口名称
接口描述
FileUploadAgent
文件上传代理
FileUploadParams
上传文件参数对象
FileUploadResponse
上传文件结果返回对象
CommQueryAgent
通用查询代理
CommQueryResponse
通用查询返回对象
ErrFileDownloadAgent
下载错误文件代理
ErrFileDownloadParams
下载错误文件参数对象
ErrFileDownloadResponse
下载错误结果返回对象
CertQueryAgent
查询证书有效期对象
2.2Java接口API说明
Jar包名称：
sitrb.jar
依赖包：
Axis1.4
开发环境要求：
支持Eclipse等各类Java开发工具，J2SE1.4及以上版本。
运行环境要求：
JRE1.4以及上版本，可以部署在J2EE容器内运行。
2.2.1上传
2.2.1.1FileUploadAgent
上传文件代理类，上传文件时调用此类。
构造方法摘要
FileUploadAgent（）
初始化一个建新的FileUploadAgent对象。
方法摘要
FileUploadResponsesendAndReceive（FileUploadParamsupParams）
将请求信息发送给服务器,并返回一个FileUploadResponse对象。
构造方法详细信息
2.2.1.1.1FileUploadAgent
publicFileUploadAgnet（）
初始化一个新建的FileUploadAgent对象。
方法详细信息
2.2.1.1.2sendAndReceive
publicFileUploadResponsesendAndReceive（FileUploadParamsupParams）
将请求信息发送给服务器,并返回一个FileUploadResponse对象。
参数：
upParams–上传文件参数对象。
返回：
FileUploadResponse–上传文件结果返回对象。
2.2.1.2FileUploadParams
上传文件参数类，用于传入上传文件请求的各种参数。
构造方法摘要
FileUploadParams（）
初始化一个建新的FileUploadParams对象。
方法摘要
voidsetOrgID（StringorgID）
传入组织机构代码
voidsetBuzzType（StringtransType）
传入业务数据分类标识
voidsetSendType（StringupType）
传入上传方式，1-以文件方式上传；2-以流方式上传
voidsetUploadFileName（StringuploadFileName）
传入上传文件的文件名。
voidsetUploadStream（Stringstream）
传入待上传字符流。
以文件方式上传时不需传入该值。
voidsetCertType（StringcertType）
传入证书类型。
publicvoidsetXzscope（StringxzScope）
上传文件所属险种，必须是具体一个险种类型，如110、120、150。
构造方法详细信息
2.2.1.2.1FileUploadParams
publicFileUploadParams（）
初始化一个新建的FileUploadParams对象。
方法详细信息
2.2.1.2.2setBuzzType
publicvoidsetBuzzType（StringbuzzType）
传入本次上传的交易类型。
参数：
buzzType–本次上传的业务类型代码。
返回：
无。
2.2.1.2.3setDataFileType
publicvoidsetDataFileType（StringdataFileType）
传入数据文件类型。
参数：
dataFileType–数据文件类型。
1－TXT文件。
返回：
无。
2.2.1.2.4setSendType
publicvoidsetSendType（StringsendType）
传入上传方式。
参数：
sendType–上传方式，1-以文件方式上传。
2-以流方式上传。
返回：
无。
2.2.1.2.5setFileDate
publicvoidsetFileDate（StringsendDate）
传入文件生成日期。
参数：
fileDate–文件生成日期，格式为YYYYMMDD。
返回：
无。
2.2.1.2.6setUploadFileName
publicvoidsetUploadFileName（StringuploadFileName）
传入上传文件的文件名。
参数：
uploadFileName–文件名。
返回：
无。
2.2.1.2.7setUploadStream
publicvoidsetUploadStream（Stringstream）
传入待上传字符流。
参数：
stream–待上传字符流，当上传方式为文件方式时返回值无意义。
返回：
无。
2.2.1.2.8setCertType
publicvoidsetCertType（StringcertType）
传入证书类型。
参数：
certType–证书类型。
2－设备证书。
返回：
无。
2.2.1.2.9setXzscope
publicvoidsetXzscope（StringxzScope）
传入险种类型。
参数：
xzScope,险种类型：
110—城镇企业职工基本养老保险，120—机关事业单位养老保险，150—新型农村社会养老保险，160—城镇居民社会养老保险，170—城乡居民社会养老保险。
返回：
无。
2.2.1.3FileUploadResponse
上传结果返回对象，返回上传文件处理是否成功标志及处理信息。
构造方法摘要
FileUploadResponse（）
初始化一个建新的FileUploadResponse对象。
方法摘要
StringgetErrorFlag（）
获取上传文件处理是否成功标志。
StringgetRetMsg（）
获取上传文件处理结果信息。
StringgetStackStrace（）
获取查询操作的错误堆栈
构造方法详细信息
2.2.1.3.1FileUploadResponse
publicFileUploadResponse（）
初始化一个新建的FileUploadResponse对象。
方法详细信息
2.2.1.3.2getErrorFlag
publicStringgetErrorFlag（）
获取上传文件处理是否成功标志。
参数：
无。
返回：
String–是否成功标志。
0－成功，非0－失败（具体类型参见错误类型列表）
2.2.1.3.3getRetMsg
publicStringgetRetMsg（）
获取上传文件处理结果信息。
参数：
无。
返回：
String–上传文件处理结果信息。
2.2.1.3.4getStackTrace
publicStringgetStackTrace（）
获取上传操作的错误堆栈。
参数：
无。
返回：
String–上传操作的错误堆栈。
2.2.2通用查询
2.2.2.1CommQueryAgent
通用查询代理类，向后台发送各类业务查询请求，后台业务程序按约定格式返回查询结果。
构造方法摘要
CommQueryAgent（）
初始化一个建新的CommQueryAgent对象。
方法摘要
voidsetOrgID（StringorgID）
传入组织机构代码
StringsetCertType
（StringcertType）
传入证书类型。
voidsetBuzztype（StringFuncID）
传入查询请求业务类型。
voidsetQueryParams
（Hashmapparams）
传入查询请求参数。
不同的业务查询所需要的参数不尽相同，具体业务查询参数详见接口功能说明部分。
Stringquery（）
将请求信息发送给服务器，查询业务数据，业务程序按约定格式返回结果字符串，具体格式参见数据传输封装规范。
publicvoidsetXzscope（StringxzScope）
查询所属险种，具体一个险种类型，如110、120、150。
对应上传文件的险种类型。
构造方法详细信息
2.2.2.1.1CommQueryAgent
publicCommQueryAgent（）
初始化一个新建的CommQueryAgent对象。
方法详细信息
2.2.2.1.2setBuzzType
publicvoidsetBuzzType（StringBuzztype）
传入查询业务类型，具体类型对应业务详见接口功能列表。
参数：
BuzzType–查询请求业务类型
返回：
无。
2.2.2.1.3setDataFileType
publicvoidsetDataFileType（StringdataFileType）
传入数据文件类型。
参数：
dataFileType–数据文件类型。
1－TXT文件。
返回：
无。
2.2.2.1.4setCertType
publicvoidsetCertType（StringcertType）
传入证书类型。
参数：
certType–证书类型。
”2”–设备证书
返回：
无。
2.2.2.1.5setQueryParam
publicvoidsetQueryParam（Hashmapparams）
传入查询参数。
参数：
params–查询参数，不同的查询业务所需要的参数不尽相同，全部为String类型，具体参数详见接口功能列表。
返回：
无。
2.2.2.1.6query
publicCommQueryResponsequery（）
将查询请求发送到服务器，查询业务数据，业务程序按约定格式返回结果字符串，具体格式参见数据传输封装模范。
参数：
无
返回：
CommQueryResponse–返回的查询数据。
2.2.2.1.7setXzscope
publicvoidsetXzscope（StringxzScope）
传入险种类型。
参数：
xzScope,险种类型：
110—城镇企业职工基本养老保险，120—机关事业单位养老保险，150—新型农村社会养老保险，160—城镇居民社会养老保险，170—城乡居民社会养老保险。
返回：
无。
2.2.2.2CommQueryResponse
查询结果返回对象，返回下载文件处理是否成功标志,查询得到的信息和文件名。
构造方法摘要
CommQueryResponse（）
初始化一个建新的FileDownloadResponse对象。
方法摘要
StringgetErrorFlag（）
获取查询是否成功标志。
StringgetRetMsg（）
获取查询结果信息。
StringgetStackStrace（）
获取查询操作的错误堆栈
StringgetDownFileName（）
获取查询结果的文件名称。
StringgetDownStream（）
获取查询结果。
构造方法详细信息
2.2.2.2.1CommQueryResponse
publicFileDownloadResponse（）
初始化一个新建的FileDownloadResponse对象。
方法详细信息
2.2.2.2.2getErrorFlag
publicStringgetErrorFlag（）
获取下载文件处理是否成功标志。
参数：
无。
返回：
String–是否成功标志。
0－成功，非0－失败（具体类型参见错误类型列表）
2.2.2.2.3getRetMsg
publicStringgetRetMsg（）
获取下载文件处理结果信息。
参数：
无。
返回：
String–下载文件处理结果信息。
2.2.2.2.4getDownFileName
publicStringgetDownFileName（）
获取下载后的文件名称。
参数：
无。
返回：
String–下载后的文件名称。
2.2.2.2.5getStackTrace
publicStringgetStackTrace（）
获取上传文件处理结果信息。
参数：
无。
返回：
String–上传操作的错误堆栈。
2.2.2.2.6getDownStream
publicStringgetDownStream（）
获取下载的字符流。
参数：
无。
返回：
String–下载的字符流。
2.2.3错误文件下载
2.2.3.1ErrFileDownloadAgent
错误文件下载代理类，下载错误文件时调用此类。
构造方法摘要
ErrorFileDownloadAgent（）
初始化一个建新的ErrorFileDownloadAgent对象。
方法摘要
FileDownloadResponsesendAndDownloadErrFile（ErrFileDownloadParamserrDownParams）
将下载错误文件的请求参数发送给服务器，下载错误文件，并返回一个FileDownloadResponse对象。
publicvoidsetXzscope（StringxzScope）
下载文件所属险种，是具体一个险种类型，如110、120、150。
对应上传文件的险种类型。
构造方法详细信息
2.2.3.1.1ErrFileDownloadAgent
publicFileDownloadAgnet（）
初始化一个新建的FileDownloadAgent对象。
方法详细信息
2.2.3.1.2sendAndDownloadErrFile
publicFileDownloadResponsesendAndDownloadErrFile（ErrFileDownloadParamserrDownParams）
将请求信息发送给服务器，下载错误文件，并返回一个FileDownloadResponse对象。
参数：
errDownParams–下载错误文件参数对象。
返回：
FileDownloadResponse–下载文件结果返回对象。
2.2.3.2ErrFileDownloadParams
下载错误文件参数类，用于传入下载错误文件的各种参数。
构造方法摘要
ErrFileDownloadParams（）
初始化一个建新的ErrFileDownloadParams对象。
方法摘要
voidsetOrgID（StringorgID）
传入组织机构代码
StringsetDataFileType（StringdataFileType）
传入数据文件类型。
StringsetOrignalFileName（StringorignalFileName）
传入上传原文件名。
StringsetCertType
（StringcertType）
传入证书类型。
publicvoidsetXzscope（StringxzScope）
下载文件所属险种，是具体一个险种类型，如110、120、150。
对应上传文件的险种类型。
构造方法详细信息
方法详细信息
2.2.3.2.1setCertType
publicvoidsetCertType（StringcertType）
传入证书类型。
参数：
certType–证书类型。
”2”–设备证书
返回：
无。
2.2.3.2.2setDataFileType
publicvoidsetDataFileType（StringdataFileType）
传入数据文件类型。
参数：
dataFileType–数据文件类型。
1－TXT文件。
返回：
无。
2.2.3.2.3setOrignalFileName
publicvoidsetOrignalFileName（StringorignalFileName）
传入证书类型。
参数：
orignalFileName–待下载的错误文件名。
返回：
无。
2.2.3.2.4setXzscope
publicvoidsetXzscope（StringxzScope）
传入险种类型。
参数：
xzScope,险种类型：
110—城镇企业职工基本养老保险，120—机关事业单位养老保险，150—新型农村社会养老保险，160—城镇居民社会养老保险，170—城乡居民社会养老保险。
返回：
无。
2.2.3.3ErrFileDownloadResponse
下载文件结果返回对象，返回下载文件处理是否成功标志、处理信息和下载后的文件名。
构造方法摘要
ErrFileDownloadResponse（）
初始化一个建新的FileDownloadResponse对象。
方法摘要
StringgetErrorFlag（）
获取上传文件处理是否成功标志。
StringgetRetMsg（）
获取上传文件处理结果信息。
StringgetDownFileName（）
获取下载后的文件名称。
当下载数据文件类型为2-字符流时，文件名无意义。
StringgetDownStream（）
获取下载后的字符流。
构造方法详细信息
2.2.3.3.1ErrFileDownloadResponse
publicFileDownloadResponse（）
初始化一个新建的FileDownloadResponse对象。
方法详细信息
2.2.3.3.2getErrorFlag
publicStringgetErrorFlag（）
获取下载文件处理是否成功标志。
参数：
无。
返回：
String–是否成功标志。
0－成功，非0－失败（具体类型参见错误类型列表）
publicStringgetRetMsg（）
获取下载文件处理结果信息。
参数：
无。
返回：
String–下载文件处理结果信息。
2.2.3.3.3getStackTrace
publicStringgetStackTrace（）
获取上传文件处理结果信息。
参数：
无。
返回：
String–上传操作的错误堆栈。
2.2.3.3.4getDownFileName
publicStringgetDownFileName（）
获取下载后的文件名
升级会员 