全國公民身份信息系統(tǒng)Web服務(wù)接口調(diào)用規(guī)范V1.9-1092
全國公民身份信息系統(tǒng)(NCIIS )Web 服務(wù)接口調(diào)用規(guī)范全國公民身份證號碼查詢服務(wù)中心2014年1月第 1 頁 共 25 頁 ,目錄第一章第二章第三章3.1第四章4.1
全國公民身份信息系統(tǒng)
(NCIIS )
Web 服務(wù)接口調(diào)用規(guī)范
全國公民身份證號碼查詢服務(wù)中心
2014年1月
第 1 頁 共 25 頁
,目錄
第一章
第二章
第三章
3.1
第四章
4.1
4.2
第五章
5.1
5.2
第六章
第七章
7.1
7.2
7.3
第八章 概述 ............................................................................................................ 3 文檔描述 ..................................................................................................... 4 術(shù)語和定義.................................................................................................. 5 縮略語 . ........................................................................................................ 5 基本框架 ..................................................................................................... 6 概念模型 ..................................................................................................... 6 應(yīng)用場景 ..................................................................................................... 6 接口定義 ..................................................................................................... 7 服務(wù)條件模板獲取 . ...................................................................................... 7 WS 號碼姓名核查比對(支持單條和批量) ............................................... 8 HTTPS 設(shè)置 . ............................................................................................. 15 客戶端調(diào)用說明示例 ................................................................................. 18 XFIRE 介紹 . .............................................................................................. 18 客戶端訪問代碼示例 ................................................................................. 19 常見問題描述 ............................................................................................ 24 其他 .......................................................................................................... 25
第 2 頁 共 25 頁
,第一章 概述
全國公民身份信息系統(tǒng)是以全國公安人口信息管理系統(tǒng)提供的數(shù)據(jù)為基礎(chǔ),通過互聯(lián)網(wǎng)和行業(yè)專網(wǎng)向政府部門、社會各界、人民群眾依法提供公民身份信息服務(wù)。公民身份信息核查是全國公民身份信息系統(tǒng)(NCIIS)的主要功能,是系統(tǒng)對外服務(wù)的核心業(yè)務(wù)。Web 服務(wù)接口為典型的行業(yè)客戶提供了使用全國公民身份信息系統(tǒng)的訪問接口,該接口透明的代理了NCIIS 現(xiàn)有功能,為客戶基于二次開發(fā)并將NCIIS 現(xiàn)有功能集成到自身業(yè)務(wù)系統(tǒng)提供了技術(shù)基礎(chǔ)。本W(wǎng)eb 服務(wù)接口的設(shè)計(jì)與實(shí)現(xiàn)遵循目前 Web Services主流技術(shù)架構(gòu),滿足開放系統(tǒng)的標(biāo)準(zhǔn)化規(guī)范要求。
第 3 頁 共 25 頁
,第二章 文檔描述
本文檔用于說明客戶端調(diào)用全國公民身份信息系統(tǒng)Web 服務(wù)接口規(guī)范。用于進(jìn)行相關(guān)人口信息資源的核查訪問。
如客戶端使用Java 語言實(shí)現(xiàn),建議使用xFire 實(shí)現(xiàn),且版本(xFire1.2.6)需與服務(wù)端相同,調(diào)用方式參見第八章客戶端調(diào)用說明示例。
如客戶端使用非Java 語言實(shí)現(xiàn),具體實(shí)現(xiàn)方式請參見第三方開發(fā)語言技術(shù)文檔。
1.接口描述文檔WSDL
如需獲取客戶接入服務(wù)平臺Web Services的接口描述,可以訪問以下網(wǎng)址:
其中,ipAddress 為全國公民身份信息系統(tǒng)開通的客戶接入服務(wù)器地址(域名為:api.nciic.com.cn ) 。
此WSDL 文檔描述了客戶接入服務(wù)WebServices 的全部細(xì)節(jié)和調(diào)用的方法。包括消息的格式、傳輸協(xié)議和服務(wù)地址等。
2.WSDL 文檔的解析
作為服務(wù)請求者的客戶為順利與客戶接入服務(wù)WebServices 交互,必須首先獲取該WSDL 文檔,并正確解析得到輸入輸出的各對象類。
WSLD 文檔的獲取,在IE 地址中輸入:
將頁面保存成一個文件(即*.wsdl)。因?yàn)椴捎玫氖莌ttps 協(xié)議,所以需要對此文件內(nèi)容進(jìn)行微小的調(diào)整。通過文本編輯工具打開此文件,在文件內(nèi)容的倒數(shù)第四行,即:
location="http://api.nciic.com.cn/nciic_ws/services/NciicServices" location 的值“http ”修改成“https ”,保存此文件即可。 不同的開發(fā)平臺提供了不同的WSDL 自動解析工具。如VS.NET 中的WSDL.exe 工具、Borland 公司的Jbuilder 、Bea 公司的Weblogic Workshop等。使用哪一種工具要視集團(tuán)客戶外部應(yīng)用的系統(tǒng)平臺和開發(fā)平臺具體情況以及客戶的使用習(xí)慣而定。 第 4 頁 共 25 頁 />,將 第三章 3.1 縮略語 術(shù)語和定義 SOAP WSDL 簡單對象訪問協(xié)議(Simple Object Access protocol ) Web 服務(wù)描述語言(Web Service Description Language ) XFire Java SOAP框架 第 5 頁 共 25 頁 第四章 4.1 概念模型 基本框架 通過Web 服務(wù)平臺為各行業(yè)業(yè)務(wù)系統(tǒng)提供業(yè)務(wù)協(xié)作接口和數(shù)據(jù)支撐。如圖所示,客戶端向Web 服務(wù)平臺發(fā)送規(guī)范的數(shù)據(jù)訪問請求(SOAP 請求),Web 服務(wù)平臺接收數(shù)據(jù)訪問請求后調(diào)用服務(wù)層完成請求處理,并將處理結(jié)果返回給客戶端(SOAP 響應(yīng))。 4.2 應(yīng)用場景 客戶端根據(jù)服務(wù)請求的接口定義規(guī)范,開發(fā)服務(wù)請求應(yīng)用程序訪問所提供的服務(wù)。 說明: 1. 客戶信息的驗(yàn)證通過授權(quán)文件參數(shù)來完成。授權(quán)文件在合同簽署后會使用郵件等方式發(fā)送到客戶手中(為加密格式)??蛻粼诮涌谡{(diào)用時將授權(quán)文件中讀取的字符串作為服務(wù)調(diào)用時的一個接口參數(shù)傳遞給服務(wù)器端,服務(wù)端接收后通過授權(quán)文件內(nèi)容進(jìn)行身份驗(yàn)證。授權(quán)文件的內(nèi)容包括:客戶、用戶、帳號、密碼、IP 地址、具體調(diào)用的服務(wù)。 2. 采用SOAP1.2作為消息的封裝格式進(jìn)行服務(wù)請求,服務(wù)端接收到請求后進(jìn)行驗(yàn)證,驗(yàn)證通過后以SOAP1.2作為消息的封裝返回服務(wù)響應(yīng)內(nèi)容。 第 6 頁 共 25 頁 第五章 5.1 服務(wù)條件模板獲取 接口定義 接口名稱:nciicGetCondition 傳入?yún)?shù):String inLicense 參數(shù)說明: 注意: License 文件會在簽署合同后通過郵件等其他形式得到,License 文件本身為加密格式,請參考示例代碼編寫客戶端。如果授權(quán)文件中,參數(shù):客戶ID 、用戶ID 、帳號ID 、密碼(登錄口令)、服務(wù)ID 發(fā)生變化,則需要重新生成一個新的授權(quán)文件。 A )、正常返回結(jié)果: - - - 第 7 頁 共 25 頁 - 注意: 1、通過授權(quán)文件驗(yàn)證,調(diào)用nciicGetCondition 方法獲取到的條件模版xml 文件。填寫數(shù)據(jù)時,依據(jù)此模版xml 填寫(詳細(xì)說明請參看:inConditions 參數(shù)說明)。 B )、異常返回結(jié)果: - 5.2 WS 號碼姓名核查比對(支持單條和批量) 5.2.1. 功能描述 為獲得WEBSERVICE 服務(wù)許可證的客戶提供人口信息快速身份核查比對服務(wù)。根據(jù)身份證號等信息核查比對系統(tǒng)內(nèi)有無相匹配的人的基本信息,若存在則返回存在記錄數(shù),否則返回零條。分為單條核查比對和批量核查比對兩種方式進(jìn)行核查,單條核查比對只能核查一條記錄的信息,批量核查比對則可以核查多條記錄的信息,批量核查比對最多可核查200條記錄。 5.2.2. 接口與參數(shù) 接口名稱:nciicCheck 返回值: String resultXML 1:正常返回一個XML 介質(zhì)的字符串; 2:錯誤返回一個XML 介質(zhì)的字符串; 第 8 頁 共 25 頁 傳入?yún)?shù):String inLicense String inConditions 參數(shù)說明: A )、inLicense 參數(shù)說明: 注意: License 文件會在簽署合同后通過郵件等其他形式得到,License 文件本身為加密格式,請參考示例代碼編寫客戶端。如果授權(quán)文件中,參數(shù):客戶ID 、用戶ID 、帳號ID 、密碼(登錄口令)、服務(wù)ID 發(fā)生變化,則需要重新生成一個新的授權(quán)文件。 B )、inConditions 參數(shù)說明: - --> - - 第 9 頁 共 25 頁 - 注意: 1、用戶唯一識別碼:客戶填寫各自的業(yè)務(wù)帳號,集團(tuán)用戶可填寫各自的小帳號,最大長度40(20個漢字)。 業(yè)務(wù)發(fā)生地:客戶給自己的客戶辦理業(yè)務(wù)時的所在地,是6位的行政區(qū)劃編碼,最大長度6(可以填寫3個漢字)。例如:某某銀行北京市朝陽區(qū)青年路支行,此支行所在地即為業(yè)務(wù)發(fā)生地。 業(yè)務(wù)類型:客戶給自己的客戶辦理業(yè)務(wù)時,屬于哪種業(yè)務(wù)類型,最大長度40(可以填寫20個漢字)。例如:某某銀行北京市朝陽區(qū)青年路支行給市民辦理開戶、貸款、繳費(fèi)等業(yè)務(wù),此時辦理的業(yè)務(wù)名稱即為業(yè)務(wù)類型。 2、inConditions 條件xml 串中,必須輸入數(shù)據(jù)項(xiàng):公民身份號碼、姓名、用戶唯一識別碼、業(yè)務(wù)發(fā)生地、業(yè)務(wù)類型。 3、結(jié)果xml 串中的返回:公民身份號碼、姓名核查結(jié)果,以及照片(Base64編碼)。 C)、提交XML 介質(zhì)字符串inConditions (樣例): XML 介質(zhì)字符串中的數(shù)據(jù)是虛擬信息。 第 10 頁 共 25 頁