全国公民身份信息系统Web服务接口调用规范V1.9-1092
全国公民身份信息系统(NCIIS )Web 服务接口调用规范全国公民身份证号码查询服务中心2014年1月第 1 页 共 25 页 ,目录第一章第二章第三章3.1第四章4.1
全国公民身份信息系统
(NCIIS )
Web 服务接口调用规范
全国公民身份证号码查询服务中心
2014年1月
第 1 页 共 25 页
,目录
第一章
第二章
第三章
3.1
第四章
4.1
4.2
第五章
5.1
5.2
第六章
第七章
7.1
7.2
7.3
第八章 概述 ............................................................................................................ 3 文档描述 ..................................................................................................... 4 术语和定义.................................................................................................. 5 缩略语 . ........................................................................................................ 5 基本框架 ..................................................................................................... 6 概念模型 ..................................................................................................... 6 应用场景 ..................................................................................................... 6 接口定义 ..................................................................................................... 7 服务条件模板获取 . ...................................................................................... 7 WS 号码姓名核查比对(支持单条和批量) ............................................... 8 HTTPS 设置 . ............................................................................................. 15 客户端调用说明示例 ................................................................................. 18 XFIRE 介绍 . .............................................................................................. 18 客户端访问代码示例 ................................................................................. 19 常见问题描述 ............................................................................................ 24 其他 .......................................................................................................... 25
第 2 页 共 25 页
,第一章 概述
全国公民身份信息系统是以全国公安人口信息管理系统提供的数据为基础,通过互联网和行业专网向政府部门、社会各界、人民群众依法提供公民身份信息服务。公民身份信息核查是全国公民身份信息系统(NCIIS)的主要功能,是系统对外服务的核心业务。Web 服务接口为典型的行业客户提供了使用全国公民身份信息系统的访问接口,该接口透明的代理了NCIIS 现有功能,为客户基于二次开发并将NCIIS 现有功能集成到自身业务系统提供了技术基础。本Web 服务接口的设计与实现遵循目前 Web Services主流技术架构,满足开放系统的标准化规范要求。
第 3 页 共 25 页
,第二章 文档描述
本文档用于说明客户端调用全国公民身份信息系统Web 服务接口规范。用于进行相关人口信息资源的核查访问。
如客户端使用Java 语言实现,建议使用xFire 实现,且版本(xFire1.2.6)需与服务端相同,调用方式参见第八章客户端调用说明示例。
如客户端使用非Java 语言实现,具体实现方式请参见第三方开发语言技术文档。
1.接口描述文档WSDL
如需获取客户接入服务平台Web Services的接口描述,可以访问以下网址:
其中,ipAddress 为全国公民身份信息系统开通的客户接入服务器地址(域名为:api.nciic.com.cn ) 。
此WSDL 文档描述了客户接入服务WebServices 的全部细节和调用的方法。包括消息的格式、传输协议和服务地址等。
2.WSDL 文档的解析
作为服务请求者的客户为顺利与客户接入服务WebServices 交互,必须首先获取该WSDL 文档,并正确解析得到输入输出的各对象类。
WSLD 文档的获取,在IE 地址中输入:
将页面保存成一个文件(即*.wsdl)。因为采用的是https 协议,所以需要对此文件内容进行微小的调整。通过文本编辑工具打开此文件,在文件内容的倒数第四行,即:
location="http://api.nciic.com.cn/nciic_ws/services/NciicServices" location 的值“http ”修改成“https ”,保存此文件即可。
不同的开发平台提供了不同的WSDL 自动解析工具。如VS.NET 中的WSDL.exe 工具、Borland 公司的Jbuilder 、Bea 公司的Weblogic Workshop等。使用哪一种工具要视集团客户外部应用的系统平台和开发平台具体情况以及客户的使用习惯而定。
第 4 页 共 25 页 />,将
,第三章
3.1 缩略语 术语和定义
SOAP
WSDL 简单对象访问协议(Simple Object Access protocol ) Web 服务描述语言(Web Service Description Language ) XFire Java SOAP框架
第 5 页 共 25 页
,第四章
4.1 概念模型 基本框架
通过Web 服务平台为各行业业务系统提供业务协作接口和数据支撑。如图所示,客户端向Web 服务平台发送规范的数据访问请求(SOAP 请求),Web 服务平台接收数据访问请求后调用服务层完成请求处理,并将处理结果返回给客户端(SOAP 响应)。
4.2 应用场景
客户端根据服务请求的接口定义规范,开发服务请求应用程序访问所提供的服务。
说明:
1. 客户信息的验证通过授权文件参数来完成。授权文件在合同签署后会使用邮件等方式发送到客户手中(为加密格式)。客户在接口调用时将授权文件中读取的字符串作为服务调用时的一个接口参数传递给服务器端,服务端接收后通过授权文件内容进行身份验证。授权文件的内容包括:客户、用户、帐号、密码、IP 地址、具体调用的服务。
2. 采用SOAP1.2作为消息的封装格式进行服务请求,服务端接收到请求后进行验证,验证通过后以SOAP1.2作为消息的封装返回服务响应内容。
第 6 页 共 25 页
,第五章
5.1 服务条件模板获取 接口定义
接口名称:nciicGetCondition
传入参数:String inLicense
参数说明:
注意:
License 文件会在签署合同后通过邮件等其他形式得到,License 文件本身为加密格式,请参考示例代码编写客户端。如果授权文件中,参数:客户ID 、用户ID 、帐号ID 、密码(登录口令)、服务ID 发生变化,则需要重新生成一个新的授权文件。
A )、正常返回结果:
-
-
-
第 7 页 共 25 页
, -
注意:
1、通过授权文件验证,调用nciicGetCondition 方法获取到的条件模版xml 文件。填写数据时,依据此模版xml 填写(详细说明请参看:inConditions 参数说明)。
B )、异常返回结果:
-
5.2 WS 号码姓名核查比对(支持单条和批量)
5.2.1. 功能描述
为获得WEBSERVICE 服务许可证的客户提供人口信息快速身份核查比对服务。根据身份证号等信息核查比对系统内有无相匹配的人的基本信息,若存在则返回存在记录数,否则返回零条。分为单条核查比对和批量核查比对两种方式进行核查,单条核查比对只能核查一条记录的信息,批量核查比对则可以核查多条记录的信息,批量核查比对最多可核查200条记录。
5.2.2. 接口与参数
接口名称:nciicCheck
返回值: String resultXML
1:正常返回一个XML 介质的字符串;
2:错误返回一个XML 介质的字符串;
第 8 页 共 25 页
,传入参数:String inLicense
String inConditions
参数说明:
A )、inLicense 参数说明:
注意:
License 文件会在签署合同后通过邮件等其他形式得到,License 文件本身为加密格式,请参考示例代码编写客户端。如果授权文件中,参数:客户ID 、用户ID 、帐号ID 、密码(登录口令)、服务ID 发生变化,则需要重新生成一个新的授权文件。
B )、inConditions 参数说明:
-
-->
-
-
第 9 页 共 25 页
, -
注意:
1、用户唯一识别码:客户填写各自的业务帐号,集团用户可填写各自的小帐号,最大长度40(20个汉字)。
业务发生地:客户给自己的客户办理业务时的所在地,是6位的行政区划编码,最大长度6(可以填写3个汉字)。例如:某某银行北京市朝阳区青年路支行,此支行所在地即为业务发生地。
业务类型:客户给自己的客户办理业务时,属于哪种业务类型,最大长度40(可以填写20个汉字)。例如:某某银行北京市朝阳区青年路支行给市民办理开户、贷款、缴费等业务,此时办理的业务名称即为业务类型。
2、inConditions 条件xml 串中,必须输入数据项:公民身份号码、姓名、用户唯一识别码、业务发生地、业务类型。
3、结果xml 串中的返回:公民身份号码、姓名核查结果,以及照片(Base64编码)。
C)、提交XML 介质字符串inConditions (样例):
XML 介质字符串中的数据是虚拟信息。
第 10 页 共 25 页