DB23 T 3156—2022 政务信息共享交换平台接口接入.pdf

《DB23 T 3156—2022 政务信息共享交换平台接口接入.pdf》由会员分享，可在线阅读，更多相关《DB23 T 3156—2022 政务信息共享交换平台接口接入.pdf（8页珍藏版）》请在麦多课文档分享上搜索。

1、I C S 3 5 . 2 4 0 . 0 1 C C S L 6 7 DB23 黑 龙 江 省 地 方 标 准 D B 2 3 / T X X X X X X X X 政 务 信 息 共 享 交 换 平 台 接 口 接 入 X X X X - X X - X X 发 布 X X X X - X X - X X 实 施 黑 龙 江 省 市 场 监 督 管 理 局 发 布D B 2 3 / T X X X X - X X X X I 前 言 本 文 件 依 据 G B / T 1 . 1 - 2 0 2 0 标 准 化 工 作 导 则 第 1 部 分 ： 标 准 化 文 件 的 结 构 和 起

2、草 规 则 的 规 定 起 草 。 请 注 意 本 文 件 的 某 些 内 容 可 能 涉 及 专 利 。 本 文 件 的 发 布 机 构 不 承 担 识 别 这 些 专 利 的 责 任 。 本 文 件 由 黑 龙 江 省 营 商 环 境 建 设 监 督 局 提 出 并 归 口 。 本 文 件 起 草 单 位 ： 黑 龙 江 省 营 商 环 境 建 设 监 督 局 、 黑 龙 江 省 标 准 化 研 究 院 、 浪 潮 软 件 集 团 有 限 公 司 。 本 文 件 主 要 起 草 人 ： 张 建 峰 、 谭 嘉 宁 、 王 艳 君 、 侯 雨 含 、 江 中 阳 、 于 运 来 、 董 鹏

3、飞 、 张 桐 瑗 、 陈 要 武 、 杨 大 志 、 吕 猛 、 李 严 。D B 2 3 / T X X X X - X X X X 1 政 务 信 息 共 享 交 换 平 台 接 口 接 入 1 范 围 本 文 件 规 定 了 黑 龙 江 省 政 务 信 息 共 享 交 换 平 台 应 用 程 序 接 口 接 入 的 总 体 架 构 ， 以 及 接 口 接 入 的 要 求 。 本 文 件 适 用 于 黑 龙 江 省 政 务 信 息 资 源 数 据 提 供 方 接 口 接 入 的 开 发 、 建 设 和 应 用 。 2 规 范 性 引 用 文 件 下 列 文 件 中 的 内 容 通 过 文

4、 中 的 规 范 性 引 用 而 构 成 本 文 件 必 不 可 少 的 条 款 。 其 中 ， 注 日 期 的 引 用 文 件 ， 仅 该 日 期 对 应 的 版 本 适 用 于 本 文 件 ； 不 注 日 期 的 引 用 文 件 ， 其 最 新 版 本 （ 包 括 所 有 的 修 改 单 ） 适 用 于 本 文 件 。 本 文 件 没 有 规 范 性 引 用 文 件 3 术 语 和 定 义 下 列 术 语 和 定 义 适 用 于 本 文 件 。 3 . 1 政 务 信 息 资 源 政 务 部 门 在 履 行 职 责 过 程 中 制 作 或 获 取 的 ， 以 一 定 形 式 记 录 、 保

5、 存 的 文 件 、 资 料 、 图 表 和 数 据 等 各 类 信 息 资 源 ， 包 括 政 务 部 门 直 接 或 通 过 第 三 方 依 法 采 集 的 、 依 法 授 权 管 理 的 和 因 履 行 职 责 需 要 依 托 政 务 信 息 系 统 形 成 的 信 息 资 源 等 。 3 . 2 A p p l i c a t i o n P r o g r a m m i n g I n t e r f a c e 应 用 程 序 接 口 , 是 一 些 预 先 定 义 的 接 口 （ 如 函 数 、 H T T P 接 口 ） ， 或 指 软 件 系 统 不 同 组 成 部 分 衔

6、 接 的 约 定 。 用 来 提 供 应 用 程 序 与 开 发 人 员 基 于 某 软 件 或 硬 件 得 以 访 问 的 一 组 例 程 ， 而 又 无 需 访 问 源 码 ， 或 理 解 内 部 工 作 机 制 的 细 节 。 通 过 程 序 调 用 接 口 ， 通 常 用 于 查 询 或 核 验 信 息 。 4 缩 略 语 下 列 缩 略 语 适 用 于 本 文 件 。 A P I ： 应 用 程 序 接 口 ， （ A p p l i c a t i o n P r o g r a m m i n g I n t e r f a c e ） U R L ： 每 一 信 息 资 源 都

7、 有 统 一 的 且 在 网 上 唯 一 的 地 址 ， 该 地 址 就 叫 U R L ， （ U n i f o r m R e s o u r c e L o c a t o r ） 5 接 口 接 入 总 体 要 求 5 . 1 接 口 设 计 原 则 接 口 开 发 者 在 设 计 接 口 的 时 候 ， 可 以 参 考 以 下 接 口 原 则 ：D B 2 3 / T X X X X - X X X X 2 a ) 安 全 可 靠 性 原 则 ： 系 统 应 提 供 良 好 的 安 全 性 和 可 靠 性 策 略 ， 支 持 多 种 安 全 而 可 靠 的 技 术 手 段 ， 制

8、定 严 格 的 安 全 可 靠 的 管 理 措 施 ； b ) 开 放 性 原 则 ： 提 供 统 一 、 开 放 式 标 准 接 口 ， 确 保 与 其 它 系 统 的 互 联 互 通 ； c ) 灵 活 性 原 则 ： 提 供 灵 活 的 接 口 设 计 ， 适 宜 接 口 的 变 动 ； d ) 可 扩 展 性 原 则 ： 支 持 新 业 务 的 扩 展 以 及 接 口 容 量 与 接 口 性 能 的 提 高 ； e ) 可 管 理 性 原 则 ： 提 供 良 好 的 管 理 机 制 ， 确 保 在 运 行 过 程 中 提 供 给 管 理 员 方 便 的 管 理 方 式 以 处 理 各

9、种 情 况 ； f ) 统 一 性 原 则 ： 当 保 证 系 统 的 接 口 方 式 、 接 口 形 式 、 使 用 的 协 议 等 标 准 、 统 一 。 5 . 2 A P I 接 口 规 范 5 . 2 . 1 概 述 A P I 接 口 最 大 的 特 点 就 是 既 能 让 资 源 提 供 方 开 放 自 己 的 资 源 访 问 权 限 ， 又 能 确 保 数 据 安 全 性 并 让 资 源 提 供 方 继 续 握 有 控 制 权 。 资 源 提 供 方 要 根 据 业 务 情 况 描 述 接 口 功 能 ， 并 按 照 A P I 规 范 进 行 开 发 接 口 ， 能 够 让

10、使 用 方 更 好 的 应 用 接 口 。 5 . 2 . 2 协 议 A P I 与 客 户 端 用 户 的 通 信 协 议 ， 常 用 H T T P 超 文 本 传 输 协 议 和 H T T P S 安 全 超 文 本 传 输 协 议 两 种 。 5 . 2 . 3 接 口 类 型 查 询 类 接 口 常 用 接 口 类 型 主 要 有 以 下 两 种 ： a ) H T T P A P I 接 口 ： 请 求 报 文 通 常 为 K e y - V a l u e 形 式 ， 返 回 报 文 一 般 为 J S O N 串 ， 有 G E T 和 P O S T 等 方 法 ； b

11、) W e b S e r v i c e 接 口 ： 通 常 走 S O A P 协 议 通 过 H T T P 传 输 ， 请 求 报 文 和 返 回 报 文 都 是 X M L 格 式 。 5 . 2 . 4 版 本 控 制 5 . 2 . 4 . 1 应 该 将 A P I 的 版 本 号 放 入 U R L 。 5 . 2 . 4 . 2 采 用 多 版 本 并 存 、 增 量 发 布 的 方 式 ， 对 于 一 个 A P I 或 服 务 ， 应 在 生 产 中 最 多 保 留 3 个 最 详 细 的 版 本 。 版 本 号 分 为 整 型 和 浮 点 型 ， 整 型 ： 大 功

12、能 版 本 ， 如 v 1 、 v 2 ； 浮 点 型 ： 补 充 功 能 版 本 ， 如 v 1 . 1 、 v 2 . 1 。 5 . 2 . 5 请 求 方 式 查 询 类 接 口 常 用 请 求 方 式 主 要 有 以 下 两 种 方 式 ： a ) G E T ： 从 服 务 器 取 出 资 源 （ 一 项 或 多 项 ） ； b ) P O S T ： 在 服 务 器 新 建 一 个 资 源 。 5 . 2 . 6 请 求 参 数 接 口 入 参 一 般 为 X M L 、 J S O N 格 式 ， 常 用 传 入 参 数 主 要 分 为 3 种 类 型 ： a ) P a r

13、a m s ： U R L 后 面 的 参 数 ， 存 放 请 求 接 口 的 参 数 数 据 ； b ) H e a d e r ： 消 息 头 ， 根 据 需 要 存 放 公 共 参 数 、 R e q u e s t I d （ 请 求 者 标 识 ） 、 T o k e n （ 身 份 验 证 令 牌 ） 、 加 密 字 段 等 ； c ) B o d y ： 消 息 体 ， 存 放 请 求 接 口 的 参 数 数 据 。 注：资源提供方根据共享要求及相关安全考虑， 可在接口入参中增加调用I P 、 访问人身份证号、 调用时间戳等字段。D B 2 3 / T X X X X - X X

14、 X X 3 5 . 2 . 7 过 滤 信 息 若 记 录 数 量 很 多 ， 服 务 器 不 可 能 返 回 全 部 记 录 给 用 户 ， A P I 应 该 提 供 分 页 参 数 及 其 它 筛 选 参 数 ， 过 滤 返 回 结 果 。 5 . 2 . 8 返 回 参 数 返 回 参 数 包 括 ： a ) c o d e ： 接 口 响 应 状 态 代 码 ， 资 源 提 供 方 可 自 行 定 义 。 如 接 口 调 用 成 功 ， 返 回 2 0 0 ； b ) m s g ： 对 S t a t u s 返 回 的 代 码 进 行 具 体 解 释 。 如 接 口 调 用 失

15、 败 ， 返 回 具 体 错 误 信 息 ； c ) d a t a ： 接 口 返 回 的 具 体 数 据 。 示例： c o d e : 2 0 0 , m s g : 接口调用成功 , d a t a : e r r o r : 该人员未参加失业保险 5 . 2 . 9 其 他 其 他 内 容 包 括 ： a ) 如 有 业 务 需 要 ， 接 口 设 计 时 应 考 虑 限 流 设 计 、 熔 断 设 计 、 降 级 设 计 等 ； b ) 如 有 业 务 需 要 ， 接 口 设 计 时 应 考 虑 敏 感 数 据 脱 敏 处 理 ， 部 分 数 据 加 “ * ” 号 处 理 ； c

16、 ) 日 志 平 台 设 计 ： 日 志 平 台 有 利 于 故 障 定 位 和 日 志 统 计 分 析 ； d ) 当 记 录 数 量 很 多 时 ， A P I 应 该 提 供 分 页 参 数 及 其 它 筛 选 参 数 ， 过 滤 返 回 结 果 。 5 . 2 . 1 0 接 口 文 档 接 口 文 档 中 应 包 含 以 下 内 容 ： a ) 接 口 地 址 ： 不 包 含 接 口 B A S E 地 址 ； b ) 请 求 方 式 : G E T 、 P O S T 等 ； c ) 请 求 参 数 ： 数 据 格 式 （ 默 认 J S O N ） 、 参 数 含 义 、 参 数

17、 类 型 、 长 度 、 精 度 等 ； d ) 响 应 参 数 ： 参 数 含 义 、 参 数 类 型 、 值 域 等 ； e ) 错 误 代 码 表 ； f ) 其 他 ： 如 算 法 生 成 说 明 ， 例 T o k e n 。 注：当接口发生变化时，应及时更新接口文档并提供给资源需求方。 6 接 口 接 入 流 程 6 . 1 接 口 接 入 流 程 图 接 口 接 入 流 程 图 见 图 1 。D B 2 3 / T X X X X - X X X X 4 图 1 接 口 接 入 流 程 图 6 . 2 接 口 接 入 准 备 阶 段 6 . 2 . 1 接 口 开 发 资 源 提

18、 供 方 需 根 据 接 口 需 要 开 发 相 应 的 接 口 ， 并 提 供 一 份 接 口 使 用 说 明 文 档 。 6 . 2 . 2 存 量 数 据 处 理 接 口 后 台 的 数 据 应 保 证 其 实 时 性 及 全 面 性 ， 并 且 数 据 有 更 新 时 应 保 证 接 口 的 返 回 参 数 尽 量 不 会 发 生 改 变 。 6 . 2 . 3 资 源 确 认 省 数 据 共 享 交 换 平 台 需 确 认 资 源 提 供 方 提 供 的 接 口 是 否 符 合 的 要 求 。 6 . 2 . 4 接 口 测 试D B 2 3 / T X X X X - X X X

19、X 5 确 认 接 口 符 合 要 求 后 ， 资 源 提 供 方 需 提 供 接 口 测 试 环 境 访 问 地 址 、 接 口 入 参 等 相 关 信 息 ， 由 省 数 据 共 享 交 换 平 台 对 接 口 进 行 联 调 ， 测 试 接 口 是 否 可 以 正 常 使 用 。 6 . 2 . 5 资 源 注 册 、 审 核 省 数 据 共 享 交 换 平 台 ， 将 资 源 提 供 方 提 供 的 接 口 在 平 台 上 进 行 接 口 注 册 ， 并 进 行 资 源 审 核 。 6 . 2 . 6 接 口 上 线 省 数 据 共 享 交 换 平 台 对 接 口 进 行 测 试 且

20、能 够 正 常 使 用 后 ， 可 将 接 口 发 布 上 线 。 7 特 殊 情 况 处 理 如 发 生 如 下 情 况 ， 需 要 通 知 省 数 据 共 享 交 换 平 台 ， 并 重 新 调 试 接 口 ： a ) 原 始 接 口 地 址 发 生 变 化 ； b ) 原 始 接 口 返 回 参 数 发 生 变 化 ； c ) 原 始 接 口 遇 到 如 服 务 器 升 级 、 网 络 异 常 导 致 接 口 不 通 。D B 2 3 / T X X X X - X X X X 6 参 考 文 献 1 政 务 信 息 资 源 共 享 管 理 暂 行 办 法 （ 国 发 2 0 1 6 5

21、 1 号 ） 2 政 务 信 息 系 统 整 合 共 享 实 施 方 案 （ 国 办 发 2 0 1 7 3 9 号 ） 3 国 家 发 展 改 革 委 关 于 印 发 “ 十 三 五 ” 国 家 政 务 信 息 化 工 程 建 设 规 划 的 通 知 （ 发 改 高 技 2 0 1 7 1 4 4 9 号 ） 4 国 务 院 关 于 加 快 推 进 全 国 一 体 化 在 线 政 务 服 务 平 台 建 设 的 指 导 意 见 （ 国 发 2 0 1 8 2 7 号 ） 5 全 国 一 体 化 在 线 政 务 服 务 平 台 数 据 共 享 服 务 管 理 暂 行 办 法 （ 国 办 电 政 函 2 0 1 9 2 3 5 号 ） 6 国 务 院 办 公 厅 关 于 建 立 健 全 政 务 数 据 共 享 协 调 机 制 加 快 推 进 数 据 有 序 共 享 的 意 见 （ 国 办 发 2 0 2 1 6 号 ） _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _