人口库_基准信息查询服务接口说明

国家人口基础信息库建设项目 国家数据共享交换平台 接口对接技术规范 版本号 V2 5 公安部科技信息化局 2018 年 1 月 1 日 1 目录 1接口分类接口分类 2 2接口定义接口定义 2 2 1接口信息 2 2 2WSDL 描述文件 2 2 3接口参数定义 3 2 3 1Header参数 3 2 3 2国家平台认证参数 3 2 3 3输入参数 3 2 3 4输出参数 4 2 4接口服务申请和授权 4 2 5基本约定 6 2 5 1传输协议和消息封装格式 6 2 5 2数据格式 6 2 6服务请求数据 7 2 6 1包体格式 7 2 6 2请求数据包体格式说明 7 2 7服务反馈结果 8 2 7 1包体格式 8 2 7 2反馈结果信息格式说明 9 2 8返回代码及返回描述 10 2 8 1返回代码表 10 2 8 2公民身份号码匹配度代码表 11 2 8 3姓名匹配度代码表 11 3服务数据描述服务数据描述 12 3 1信息查询服务 12 3 1 1请求数据 12 3 1 2结果说明 13 3 2身份核查服务 14 3 2 1请求数据 14 3 2 2结果说明 16 4调用示例调用示例 17 2 1 接口分类接口分类 共享服务接口分类如表所示 共享服务接口分类 接口名称接口名称说明说明 GK JZCX RKJCXXCX 基准信息查询接口 GK GXFW SFHC 身份核查服务接口 2 接口定义接口定义 2 1 接口信息接口信息 接口类型 webservice 接口格式 XML 接口编码 UTF 8 接口地址 访问地址请参考下发的授权信息文档内容 2 2 WSDL 描述文件描述文件 1 1 信息查询 信息查询 wsdl wsdl http XX XXX XX XX gkgxfw WebService JZCXService ws wsdl 2 2 身份核查 身份核查 wsdlwsdl http XX XXX XX XX gkgxfw WebService SFHCService ws wsdl 备注 根据国信中心代理服务地址进行替换 3 2 3 接口参数定义接口参数定义 2 3 1Header 参数参数 请求报文的header部分需要填充下列信息 参数名称参数名称参数说明参数说明 X Forwarded For 59 194 110 37 此项为固定值 2 3 2国家平台认证参数国家平台认证参数 在请求报文的标签中填充接口认证信息 参数名称参数名称参数说明参数说明 gjgxjhpt rid请求方标识 请求者标识 gjgxjhpt sid请求服务标识 接口编码 gjgxjhpt rtime程序生成 当前调用时间戳 gjgxjhpt sign对应认证环节最后获得的 sign 注意这个 sign 生成之后五分钟有 效期 上述参数中需要实时生成 具体生成方法请参考 国家共享平台接口认证方式说 明文档 docx 2 3 3输入参数输入参数 输入参数 输入参数 String in0 String in1 String in2 in0 请求数据 是输入XML格式请求报文 详见第2 6章节和第3章节定义 in1 用户 是服务授权后分配接入用户 即授权信息中的用户栏内容 in2 用户识别码 是服务授权后分配接入用户识别码 即授权信息中的密码栏内 容 4 2 3 4输出参数输出参数 输出参数 输出参数 String out Out 反馈结果 是输出XML格式反馈结果报文 详见2 7章节和第3章节定义 2 4 接口服务申请和授权接口服务申请和授权 国家人口库共享服务接口接入申请授权基本流程如下 中央政务部门如果需要使用国家人口基础信息库服务接口 首先须按照 国家数据 共享交换平台 政务外网 部门接入指南 要求 完成部门接入工作 省级数据共享交换平台须按照 国家数据共享交换平台 政务外网 省级平台接入 指南 要求 完成省级共享平台接入工作 一 中央政务部门服务接口使用流程 1 服务申请 资源使用方登录国家共享平台进行服务申请 申请信息须附 国家数据共享交换平 台 国家人口基础信息库接口使用单位申请表 扫描件和 国家共享交换平台 国家人 口基础信息库服务使用单位白名单备案申请表 电子版 说明 服务申请环节 需线下流程辅助 即资源使用方填写 国家数据共享交换平 5 台 国家人口基础信息库接口使用单位申请表 送交公安部进行审批 2 服务授权 公安部相关人员登录国家共享平台进行服务授权 3 生成授权码 国家共享平台生成服务接口调用授权码 APPkey 同时备案 4 获取授权信息 资源使用方在用户中心 可使用服务 页面 点击查看服务申请信息 在页面中获 得如下信息 请求者身份标识 rid 服务编码 sid 授权码 APPKey 代理识别 码 资源使用方获取授权信息后即可进行服务接口调用 具体操作步骤请参考 国家数 据共享交换平台 政务外网 服务接口操作指南 二 地方政务部门服务接口使用流程 1 服务申请 资源使用方提交 国家数据共享交换平台 国家人口基础信息库接口使用单位申请 表 给省共享平台建设管理单位 由省共享平台操作员登录国家共享平台进行服务申 请 申请信息须附 国家数据共享交换平台 国家人口基础信息库接口使用单位申请表 扫描件和 国家共享交换平台 国家人口基础信息库服务使用单位白名单备案申请表 电子版 说明 服务申请环节 需线下流程辅助 即资源使用方填写 国家数据共享交换平 台 国家人口基础信息库接口使用单位申请表 送交公安部进行审批 2 服务授权 公安部相关人员登录国家共享平台进行服务授权 3 生成授权码 国家共享平台生成服务接口调用授权码 APPkey 同时备案 4 获取授权信息 省共享平台操作员在用户中心 可使用服务 页面 点击查看服务申请信息 在页 面中获得如下信息 请求者身份标识 rid 服务编码 sid 授权码 APPKey 代 理识别码 省共享平台建设管理单位负责将上述授权信息转交资源使用方 资源使用方获取授权信息后即可进行服务接口调用 具体操作步骤请参考 国家数 6 据共享交换平台 政务外网 服务接口操作指南 三 注意事项 国家数据共享交换平台以及省级建设管理平台一级代理接入设备 最外层的代理服 务器或负载均衡或服务总线 必须开启携带源 IP 地址设置 并且将源地址放入 http 请求头中的 X Forwarded ForX Forwarded For 字段中 以便国家人口库接口服务器能获得服务请求端 IP 地址 如果在 http 请求头中的 X Forwarded ForX Forwarded For 无法获取源端地址则拒绝服务 2 5 基本约定基本约定 2 5 1传输协议和消息封装格式传输协议和消息封装格式 传输协议和消息封装格式为 a 采用 HTTP 或 HTTPS 作为传输协议 b 采用 SOAP 作为消息的封协议 2 5 2数据格式数据格式 接口参数和返回值采用XML标准格式 由声明和包体两部分组成 如图所示 声明包体 图 1 接口参数和返回值格式 声明部分符合XML 1 0规范 采用GB13000的UTF 8编码 使用XML语言表述如下 包体部分规格符合以下要求 a 服务请求数据的包体符合 2 5 的规定 b 服务返回结果的包体符合 2 6 的规定 7 2 6 服务请求数据服务请求数据 2 6 1包体格式包体格式 服务请求数据包体部分由数据包描述和多条数据记录组成 每条数据记录由多个数 据项组成 如图所示 图 2 请求数据包体格式 2 6 2请求数据包体格式说明请求数据包体格式说明 2 6 2 1包体部分的所有内容放置在标记 之间 2 6 2 2数据包描述中的所有内容放置在标记 之间 2 6 2 3数据包描述内容包括 服务请求编号 请求部委代码 请求部委名称 数据来 源系统代码 数据来源系统名称 请求记录数 发送时间 如表所示 接口请求数据包描述 顺序号标记含义说明 1FWQQBH 服务请求编号授权信息中的接口请求 ID 内容 必填 2QQBWDM 请求部委代码统一为 GJXXZX 必填 3QQBWMC 请求部委名称统一为 国家信息中心 必填 4SJLYXTDM 省级政务系统所属机 构代码 省级政务系统所属机构代码 必填 5SJLYXTMC 省级政务系统所属机 构名称 省级政务系统所属机构名称 必填 6JLS 请求记录数请求记录数应不超过 5 条 必填 7FSSJ 发送时间YYYYMMDDhhmmss 必填 8QQRGMSFHM 请求人公民身份号码使用服务的请求人的公民身份号码 必填 数据包描述数据记录 1 数据项 1 数据项 n 数据记录 n 8 9QQRXM 请求人姓名使用服务的请求人的姓名 必填 10QQRDWDM 请求单位代码使用服务的单位代码 必填 11QQRDWMC 请求单位名称使用服务的单位名称 必填 12QQYWLXDM 请求业务类型代码使用服务的业务类型代码 必填 如果有业务类型代码字典 需 要按照代码规范填写 并将业务类型代码字典报给国家人口库 13QQYWLXMC 请求业务类型名称使用服务的业务类型名称 必填 14QQYWXTDM 请求业务系统代码请求来源的业务系统代码 必填 15QQYWXTMC 请求业务系统名称请求来源的业务系统名称 必填 备注 为保证接口的响应速度 服务请求数据包最大记录数为 5 条 通过设 置请求记录数 大于 5 条不予受理 注意 上表中的参数可在接口授权信息文档和注意 上表中的参数可在接口授权信息文档和 国家人口库基础信息库接口使用单国家人口库基础信息库接口使用单 位申请表位申请表 扫描件扫描件 pdf pdf 中查找 中查找 2 6 2 4所有的数据记录放置在标记 之间 2 6 2 5每一条数据记录放置在标记 之间 属性 no 为数 据的序号 其取值 n 为从 1 开始的顺序号 n 的最大值为 PACKAGEHEAD 标记 内 JLS 的表示值 请求数据记录包含的数据项应符合相关信息交换数据项标 准的规定 2 6 2 6每一个请求数据项内容放置在该数据项的标记之间 若数据项内容为空时 数 据项标记不应省略 数据项标记采用全部大写的方式表示 2 7 服务反馈结果服务反馈结果 2 7 1包体格式包体格式 返回结果部分由数据包描述和多条请求结果记录组成 请求服务失败时只返回数 据包描述 当请求数据部分发生异常时 返回异常数据错误代码和错误描述 包体格 式如图所示 数据包描述结果记录 1结果记录 n 9 图 3 返回结果数据包体格式 2 7 2反馈结果信息格式说明反馈结果信息格式说明 2 7 2 1包体部分的所有内容放置在标记 之间 2 7 2 2返回数据包描述中的所有内容放置在标记 之 间 数据包描述主要包括 服务请求编号 发送时间 返回代码 返回描述 如表所示 接口返回数据包描述 顺序号标记含义说明 1 FFQQBH 服务请求编号服务申请授权时发放的服务请求编号 2 FSSJ 发送时间请求结果返回时间 YYYYMMDDhhmmss 3 FHDM 返回代码请求数据返回代码 4 FHMS 返回描述请求数据返回描述 数据项 1 数据项 n 10 2 7 2 3所有的结果信息置于 标记之间 每一条结果信息由一段 标记表示 2 7 2 4标记的 no 属性为接收请求数据中的数据序号 属性 code 为返回的 异常代码 属性 msg 为返回的异常描述 2 7 2 5当同一条件返回多组结果数据时 每组数据用 与 分隔 每组 数据不同记录间用 与分隔 属性 index 为从 1 开始 的连续流水号 表示返回结果的顺序号 2 7 2 6每个查询结果数据项放置在该数据项的标记之间 数据项标记采用全部大写的 方式表示 2 8 返回代码及返回描述返回代码及返回描述 2 8 1返回代码表返回代码表 返回代码 FHDM 返回代码返回代码返回描述返回描述 10接口调用成功 11接口调用成功 部分数据发生异常 10数据库连接失败 20接口应用内部错误 30不是有效的 XML 文件 31XML 文件不符合规范格式 32不是有效的 excel 文件 33excel 文件不符合规范格式 40用户权限不足 41服务请求超出数量限制 42非法用户 11 43单位代码不在服务范围 44非授权 IP 地址 50信息不符合数据项规范 扩展返回描述 60服务不存在 80服务超时 90系统异常 2 8 2公民身份号码匹配度代码表公民身份号码匹配度代码表 公民身份号码匹配度代码 GMSFHM PPDDM 代码代码描述描述 1 一致 2 完全匹配 3 相似匹配 4 未匹配 2 8 3姓名匹配度代码表姓名匹配度代码表 姓名匹配度代码 XM PPDDM 代码代码描述描述 1 一致 2 完全匹配 3 相似匹配 4 未匹配 12 3 服务数据描述服务数据描述 3 1 信息查询服务信息查询服务 本服务通过公民身份号码 姓名 在国家人口库中定位人员信息 并将该人的性 别 民族 出生日期 出生地信息和死亡标识进行反馈 3 1 1请求数据请求数据 服务中请求条件数据项应符合国家人口库数据元的规定 如表所示 请求条件数据项 序号序号数据项名称数据项名称数据项标识符数据项标识符说明说明 1 公民身份号码 GMSFHM 不可为空 2 姓名 XM 不可为空 请求数据格式如示例所示 示例 示例 CDATA 4660c10a 6aef 4a75 8b19 90b3b1b34e2f GJXXZX 国家信息中心 11130000MB1367373L 中共河北省委网络安全和信息化领导小组办公室 河北省互联网信息 办公室 2 20190124150131韩冰 11130900000533149W 沧州市人民政府办公室 dbhc 低保核查 czsdbhcxt 沧州市低保核查系统 13张三张三 3 1 2结果说明结果说明 返回信息数据项应符合国家人口库数据元的规定 具体信息数据项如表所示 信息查询结果信息 序号序号数据项名称数据项名称数据项标识符数据项标识符说明说明 1 公民身份号码 GMSFHM 非空项 2 姓名 XM 非空项 3 性别 XBDM 4 民族 MZDM 5 出生日期 CSRQ 6 出生地 国家 地区 CSD GJHDQDM 7 出生地 省市县 区 CSD SSXQDM 8 公民身份号码 匹配度代码 GMSFHM PPDDM 非空项 9 姓名 匹配度代码 XM PPDDM 非空项 10 死亡标识 SWBS 0 有效人口 1 死亡人口 14 返回结果数据格式如示例所示 示例 示例 4660c10a 6aef 4a75 8b19 90b3b1b34e2f 20190220111439 10 接口调用成功4 张三 44 张三 4 3 2 身份核查服务身份核查服务 本服务通过公民身份号码 姓名 在国家人口库中确认是否存在该人信息 反馈 核查结果和死亡标识 3 2 1请求数据请求数据 服务中请求条件数据项应符合国家人口库数据元的规定 如表所示 请求条件数据项 15 序号序号数据项名称数据项名称数据项标识符数据项标识符说明说明 1 公民身份号码 GMSFHM 不可为空 2 姓名 XM 不可为空 请求数据格式如示例所示 示例 示例 CDATA 4660c10a 6aef 4a75 8b19 90b3b1b34e2f GJXXZX 国家信息中心 11130000MB1367373L 中共河北省委网络安全和信息化领导小组办公室 河北省互联网信息 办公室 2 20190124150131韩冰 11130900000533149W 沧州市人民政府办公室 dbhc 低保核查 czsdbhcxt 沧州市低保核查系统张三张三 16 3 2 2结果说明结果说明 返回信息数据项应符合国家人口库数据元的规定 具体信息数据项如表所示 身份核查结果信息 序号序号数据项名称数据项名称数据项标识符数据项标识符说明说明 1 公民身份号码 GMSFHM 非空项 2 姓名 XM 非空项 3 公民身份号码 匹配度代码 GMSFHM PPDDM 非空项 4 姓名 匹配度代码 XM PPDDM 非空项 5 死亡 注销 标识 SWBS 0 有效人口 1 死亡人 口 返回结果数据格式如示例所示 示例 示例 4660c10a 6aef 4a75 8b19 90b3b1b34e2f 20190220111439 10 接口调用成功4 张三 44 张三 4 17 4 调用示例调用示例 使用 soapui 工具调用