户籍信息查询接入规范
户籍信息查询接入规范
鉴权数据中心
目录
1 2
概述.................................................................................................................................................. 4 接口介绍 .......................................................................................................................................... 4 2.1 通讯协议 ....................................................................................................................................... 4 2.2 安全协议 ....................................................................................................................................... 4 2.2.1 加解密 ................................................................................................................................... 4 2.2.2 签名方式 ............................................................................................................................... 4 2.3 接入规则 ....................................................................................................................................... 5 2.3.1 IP绑定 ................................................................................................................................... 5 2.3.2 使用范围 ............................................................................................................................... 5 2.3.3 字符编码 ............................................................................................................................... 5 2.4 户籍信息查询 ............................................................................................................................... 5 2.4.1 请求接口地址(POST、GET) ............................................................................................... 5 2.4.2 请求接口 ............................................................................................................................... 5 2.4.3 接口返回 ............................................................................................................................... 7 2.4.4 错误代码定义 ....................................................................................................................... 9
1 概述
户籍信息查询规范文档主要用于制定标准的接口接入准则及流程,指导用户开发人员及测试等相关技术人员快速了解鉴权数据中心提供的数据接口方式和相关规范,并且方便快捷的实现接口对接。
2 接口介绍
2.1 通讯协议
鉴权数据中心对外数据接口主要以http协议发布
2.2 安全协议
2.2.1 加解密
鉴权数据中心接口根据主流加解密方法定义了标准统一的加解密方式,DESede进行加解密,即:鉴权数据中心针对用户申请的接口分配唯一的接入秘钥,用户通过所分配的秘钥及任意随机的8位偏移量进行数据加密。
String data = allJson.toString();
System.out.println("请求报文:"+data); //平台分配的唯一的接入秘钥
String privateKey = "l4mdofLTvHkyONpdlyXBiaTv"; String vector = "12345678"; //随机8位偏移量
String encrData = Cipher3DES.encrypt(data, privateKey, vector);
System.out.println("加密报文:"+encrData);
2.2.2 签名方式
接入方对自己加密完成的请求报文字符串进行签名(注意:是加密后再签名),鉴权数据中心提供统一的RSA签名方式,即:用户可在平台在线生成或者自行生成签名密钥对,同时将签名公钥上传至平台,私钥留下自己注意保密,通过生成的签名私钥进行签名,产生签名值。通过平台签名公钥和平台返回签名值进行验签。
//根据用户自己的签名私钥对加密报文进行签名
String signature=RsaSignCoder.sign(encrData, signPrivateKey);
System.out.println("签名值:"+signature);
//根据平台签名公钥对平台返回的加密报文进行验证签名
boolean isTrue=RsaSignCoder.verify(datas, signPublicKey, sign);
注:具体请参考示例代码
2.3 接入规则
2.3.1 IP绑定
用户在进行接入的时候需要向鉴权数据中心提供接入服务器的一个或多个公网IP。
2.3.2 使用范围
鉴权数据中心对于敏感数据接口,每次请求需要说明查询原因作为中心留存,用户必须与鉴权数据中心签署数据使用相关责任协议。鉴权数据中心会为每一个接入用户分配唯一的用户编号,用户可使用同一个用户编号申请多个数据接口,但每个接口分别生成不同的密钥进行加解密及签名。
注:鉴权数据中心针对一个用户多接口只提供多个加密秘钥,一个签名公钥,本地签名密钥对用户自己生成。
2.3.3 字符编码
鉴权数据中心接口接收和返回统一以UTF-8字符集编码格式进行接收返回
2.4 户籍信息查询
2.4.1 请求接口地址(POST、GET)
http://test.api.hfdatas.com/superapi/super/householdInfo/query
2.4.2 请求接口
请求条件报文格式:
{
"header":{
"qryBatchNo": "[**************]23", "userCode": "TEST10001",
"sysCode": "TESTAPP10001",
"qryReason": "信贷", "qryDate": "20160526", "qryTime": "113106" },
"condition": {
"realName": "张三",
"idCard": "[***********]" }
2.4.3 接口返回
resCode结果为:00: 成功查得且一致、98: 未查得或查得但是不一致
正确返回报文格式:
{
"header":{
"qryBatchNo": "[**************]23", "userCode": "HFUSER10001", "sysCode": "APP10001", "qryReason": "信贷", "qryDate": "20160526", "qryTime": "030322" { {
"data": [ {
"name": "户籍信息查询", "recordNum": 1, "record": [ {
"realName": "丁健锋",
"idCard": "[***********]", "nativePlace": "上海市金山县", "birthDay": "1980-03-19", "sex": "01",
"education": "初中", "maritalStatus": "06", "photo": "",
"birthPlace": "上海市金山县", "nation": "汉族", "formerName": "", "address": "漕泾镇",
"company": "金山区漕泾镇邓桥村", "resCode": "00",
"resDesc": "成功查得且一致" }
] } ] } },
错误返回报文格式:
{ }
"msg": {
"codeDesc": "姓名校验不通过", "code": "01" }
备注:不收费代码:10、20、30、40、44、55、66、77、88、99 其余都收费