乡村振兴大数据 交换和共享规范DB11/T 2268-2024.pdf
ICS 35.240 CCS B 04 DB 11 北京市地方标准 DB11/T 2268 2024 乡村振兴大数据 交换和共享规范 Big data for rural revitalization Data exchange and sharing specification 2024-06-28发布 2024-10-01实施 北京市市场监督管理局 发布 DB11/T 2268 2024 I 目次 前言.II 1 范围.3 2 规范性引用文件.3 3 术语和定义.3 4 数据交换和共享范围.4 5 交换和共享流程.4 6 元数据属性.4 7 元数据扩展.5 8 数据交换与共享元数据.6 9 数据交换与共享方法.9 10 数据接口方式及说明.10 参考文献.14 DB11/T 2268 2024 II 前言 本文件按照 GB/T 1.1 2020标准化工作导则 第 1部分:标准化文件的结构和起草规则的规定起草。本文件由北京市农业农村局提出并归口。本文件由北京市农业农村局组织实施。本文件起草单位:北京市农业农村局、北京市数字农业农村促进中心、北京市农林科学院数据科学与农业经济研究所、北京市标准化研究院。本文件 主要 起草 人:马荣才、李理、于峰、王永泉、赵翔宇、张军、罗长寿、陆阳、余军、栾汝朋、张金轶、张宇、王晓丽、魏清凤、芦天罡、刘新、闫涛、曹承忠、郑亚 明、赵瑞芳、平阳、王一罡、薛晓娟、范 媛媛、王淼、秦向阳、孟鹤、王富荣、杨蕾、周巧霖。DB11/T 2268 2024 3 乡村振兴大数据 交换和共享规范 1 范围 本文件规定 了乡 村 振兴大 数据交换和共享范围、交换和共享流程、元数据属性、元数据扩展、数据交换与共享元数据、数据交换与共享方法、数据接口方式及说明。本文件 适 用 于 北京市 乡 村 振兴大 数据交换和共享 管理。2 规范性引用文件 下列 文件中的 内容通过 文中的规范性引用 而 构 成 本文件 必不可少 的 条款。其 中,注日期 的引用文件,仅该日期对应 的 版 本 适 用 于 本文件;不注日期 的引用文件,其 最 新版 本(包括 所 有 的 修改 单)适 用 于 本文件。GB/T 7408.1 日期 和 时间 信息 交换 表示 法 第 1部分:基 本 原 则 GB/T 13000 信息技 术 通 用 多八 位 编码 字 符集(UCS)3 术语和定义 下列 术语和定义 适 用 于 本文件。元数据 metadata 定义和 描述 其 他 数据的数据。GB/T 26816 2011,3.2 元数据元素 metadata element 元数据的 基 本单元。注:元数据元 素在 元数据实 体 中 是唯 一 的。GB/T 26816 2011,3.3 元数据实体 metadata entity 一 组说明 信息资源相关特 性的元数据元 素。注:可 以包含 一 个或 一 个以上 元数据实 体。GB/T 26816 2011,3.4 数据交换与共享 data exchange and sharing 实 现 不 同地域、不 同计算机、不 同软 件的用 户获取或 交换 非 本 机 数据并进 行各种操 作、运算 和分 析的 过 程。DB11/T 2268 2024 4 数据接口 data interface 进 行 数据 传输时,数据提 供 方和接 收 方 需遵守 的接口 约束或 规定。NY/T 3501 2019,3.6 4 数据交换和共享范围 乡 村 振兴大 数据交换和共享范围 如 下:乡 村 振兴 数据 在 农业农村局 内 部 现有相关 应 用 系统 的数据交换与共享;乡 村 振兴 数据与 下 属 各事 业单位 相关 应 用 系统之间 的数据交换与共享;乡 村 振兴 数据与农业农村部 相关 应 用 系统之间 的数据交换与共享;乡 村 振兴 数据与 其 他横 向 部 门信息系统之间为 了 实 现 业 务协同 进 行 的数据交换与共享。5 交换和共享流程 乡 村 振兴大 数据交换和共享 基 本流程 见图 1。图 1 数据交换和共享基本流程 6 元数据属性 采 用 摘 要 表示 的方式定义和 描述 元数据,摘 要内容 包括以 下 9个 属性:a)中文 名称:指 元数据元 素或 元数据实 体 的中文 名称;b)定义:描述 元数据实 体或 元数据元 素 的 基 本 内容,给 出 信息资源某个特 性的 解释 和说明;c)英 文 名称:元数据实 体或 元 素 的 英 文 名称,一 般 用 英 文 全称。所 有 组 成 词汇为 无缝连写。元数 据元 素 的 首 词汇全 部 采 用 小写 字 母,其余 每 个词汇 的 首 字 母 采 用 大 写;元数据实 体 的 每 个词汇的 首 字 母 大 写;DB11/T 2268 2024 5 d)数据 类型:说明元数据元 素或 元数据实 体 的数据 类型,对 元数据元 素 的 有 效值 域 及 允许 的 有 效 操 作进 行 了 规定。例 如 整型、实 型、布尔型、字 符 串、日期 型等;e)值 域:规定 了 元数据元 素 的 有 效 取 值 范围;f)缩写 名:元数据元 素或 元数据实 体 的 英 文 缩写 名称。缩写 规则 如 下:1)缩写 名在 本标准范围 内必 须 唯 一;2)缩写 名 不应 包括 任何空格、破折号、下 划线 或 分 隔 符 等;3)缩写 名 不应 使 用 复 数 形 式的 英 文单 词,除 非 该 单 词 本 身就 是 复 数 形 式,如“Goods”;4)元数据实 体 缩写 名描述 应 采 用 UCC(Upper Camel Case)方式,即每 个英 文单 词 的 首 字 母 均 大 写;元数据元 素 缩写 名描述 应 采 用 LCC(Lower Camel Case)方式,即除 第 一 个英 文单 词 外,每 个 单 词 的 首 字 母 大 写,并 把这些 单 词 组 合 起 来;5)对 存 在 国际 或行 业 领 域 惯 用 英 文 名称 缩写 的,采 用 惯 用 缩写。g)约束/条 件:说明 一 个 元数据元 素或 元数据实 体是 否选 取 的 描述符。该 描述符 分 别 为:1)M:必 选,表 明 该 元数据元 素或 元数据实 体 必 须选择。2)O:可 选,根 据实 际 应 用 可 以 选择也 可 以 不 选 的元数据元 素或 元数据实 体。已 经定义的 可选 元数据元 素 和 可 选 元数据实 体,可 指 导部 门 元数据标准 制 定 人 员充 分说明 其 信息。如 果 一 个 可 选 元数据实 体 未被使 用,则 该 实 体 所 包含 的元 素(包括 必 选 元 素)也 不 选 用。可 选元数据实 体 可 以有 必 选 元 素,但只当 可 选 实 体 被选 用 时 才成 为 必 选。3)C:条 件 必 选,当满足 约束 条 件中所定义的 条 件 时 应 选择。条 件 必 选 用 于 以 下 三 种 可 能 性 之 一:当 在多个 选项 中进 行 选择 时,至 少一 个 选项 必 选,且 必 须使 用;当另 一 个 元数据元 素 已 经 使 用 时,选 用 一 个 元数据实 体或 元数据元 素;当另 一 个 元数据元 素 已 经 选择 了一 个特 定 值 时,选 用 一 个 元数据元 素。h)最 大 出 现 次 数:说明元数据元 素或 元数据实 体 可 以 出 现 的 最 大 实 例 数 目。只 出 现 一 次 的用“1”表示,多 次重复 出 现 的用“N”表示。允许 不 为 1的 固 定出 现 次 数用 相 应 的 整型 数 值 表示,例 如“2”、“3”、“4”等;i)备 注:可 根 据 需 要对 元数据元 素或 实 体 进 一 步补充 说明。7 元数据扩展 元数据扩展的原则 7.1.1 选 取 元数据 应 考 虑 数据 资源 单位的数据 资源特 点 以 及工作的 复杂、难易 程 度,应 充 分 满足 乡 村 振兴大 数据的 利 用 以 及用 户 查询、提 取 数据的 需 要。7.1.2 选 取 的元数据 应 满足 乡 村 振兴大 数据标准化 需 求,并考 虑未来 可 能产 生 的标准化 需 求。扩展 过程中,可 参考 国 内 和 国外 先 进标准。7.1.3 新 建 的元数据 不应 与第 6章 定义的元数据中 现有 的元数据实 体、元 素、代 码表 的 名称、定义 相 冲突。7.1.4 增加 的元数据元 素 应 按照第 6章 所 确 定的 层 次 关系 进 行 合 理 组织。如 果 第 6章 现有 的元数据实体 无 法 满足 新 增 元数据的 需 要 时,可 以 新 建 元数据实 体。7.1.5 新 建 的元数据实 体 可 包含现有 的和 新 建 的元数据元 素 作 为 其 组 成 部分。7.1.6 可 用 代 码表 替代 值 域为 自 由文本的 现有 元数据元 素 的 值 域。7.1.7 可 增加 现有 代 码表 中 值 的数 量,扩 充 后 的 代 码表 应 与扩 充 前的 代 码表在 逻辑 上 保持 一 致。7.1.8 可对 现有 的元数据元 素 的 值 域 进 行 缩小。DB11/T 2268 2024 6 7.1.9 可对 现有 的元数据的 可 选 性和 最 大 出 现 次 数施 以 更严 格 的 限 制。元数据扩展的类型 信息资源在 不 同行 业、不 同地 区 应 用 时,需 要 在 应 用中 对 本文件规定的元数据进 行 补充。扩展的 类型 如 下:a)扩展元数据元 素 的 值 域;b)增加 新 的元数据元 素;c)增加 新 的元数据实 体 类型;d)对 已 有 的元数据元 素 施 加更严 格 的 限 定;e)对 已 有 元数据元 素 值 域 施 加更 多 的 限 定;f)创建 新 的元数据 代 码表 元 素(扩展 代 码表)。元数据扩展的实施 7.3.1 在 扩展元数据 之 前,应 查 阅 第 6章 中 现有 的元数据及 其 属性,根 据实 际 需 求 确认 是 否 缺 少适 用 的元数据。7.3.2 对于 每 一 个 增加 的元数据,应 按照本标准第 6章 规定,采 用 摘 要 表示 方式,定义 其 中文 名称、英 文 名称、数据 类型、值 域、注 解。7.3.3 对于新 建 的 代 码表 和 代 码表 元 素,应 说明 代 码表 中 每 个 值 的 名称、代 码以 及定义。元数据扩展的报备 当 元数据 内容不 能满足 用 户需 求 时,将 相关 的元数据标准文 档 上 报审核。审核 通过 后,可 按照 上述 实施方法扩展。8 数据交换与共享元数据 交换与共享数据名称 定义:缩 略 交换与共享数据 内容 的标 题 英 文 名称:exchangandsharingDateName 数据 类型:字 符 型 值 域:自 由文本 注 解:必 选项;最 大 出 现 次 数 为 1 交换与共享数据代码 定义:交换与共享数据 唯 一不 变 的标 识代 码 英 文 名称:exchangandsharingDateCode 数据 类型:字 符 型 值 域:自 由文本 注 解:可 选项;最 大 出 现 次 数 为 1 交换与共享数据来源 定义:说明数据交换与共享提 供 方及 其 联 系 方式的 信息 英 文 名称:exchangandsharingDateSource DB11/T 2268 2024 7 数据 类型:复合型 注 解:必 选项;最 大 出 现 次 数 为 N 8.3.1 交换与共享数据提供方 定义:提 供信息 的单位 英 文 名称:exchangandsharingDateProvider 数据 类型:字 符 型 值 域:自 由文本 注 解:必 选项;最 大 出 现 次 数 为 1 8.3.2 交换与共享数据提供方联系方式 定义:提 供信息 的单位 联 系 方式 英 文 名称:providerTelephone 数据 类型:字 符 型 值 域:7 18位数字字 符(包括 联 系 人 电话 号 码,完 整 的 电话 包括 国际 区 号、国 内长 途区 号、本 地 电话 号 和分 机 号,之间 用“-”分 隔。)注 解:必 选项;最 大 出 现 次 数 为 1 交换与共享数据信息摘要 定义:对 信息资源 内容 的 概 要 描述 英 文 名称:exchangandsharingDateAbstract 数据 类型:字 符 型 值 域:自 由文本 注 解:必 选项;最 大 出 现 次 数 为 1 交换与共享数据关键字 定义:用 于 概况 描述 数据 信息 内容 的 通 用 词、形 式化 词或 短 语 英 文 名称:exchangandsharingDateKeywords 数据 类型:字 符 型 值 域:自 由文本 注 解:可 选项;最 大 出 现 次 数 为 1 交换与共享数据格式 定义:信息资源 的 存 在 方式 英 文 名称:exchangandsharingDateFormat 数据 类型:字 符 型 值 域:电子 信息 文 档、数据 库 格 式 注 解:必 选项;最 大 出 现 次 数 为 1 数据类型 定义:标明 该 信息 项 的数据 类型 英 文 名称:dataType 数据 类型:字 符 型 DB11/T 2268 2024 8 值 域:电子 文 档 数据 存 储 类型,符 合 GB 13000的规定 注 解:必 选项;最 大 出 现 次 数 1 发布日期 定义:信息资源 提 供 方 发 布 共享 信息资源 的 日期 英 文 名称:releaseDate 数据 类型:日期 型 值 域:按照 GB/T 7408.1的规定 执 行,格 式 为 CCYY-MM-DD 注 解:可 选项;最 大 出 现 次 数 1 涉密情况 定义:对 资源 密级状态 的说明。英 文 名称:secretLevel 数据 类型:字 符 型 值 域:“公开”“秘密”“机 密”“绝密”注 解:必 选项;最 大 出 现 次 数 1 共享属性 定义:说明 信息 共享 情况 的 信息 英 文 名称:sharingRule 数据 类型:复合型 注 解:必 选项;最 大 出 现 次 数 1 8.10.1 共享类型 定义:信息资源 的共享 类型,包括 无 条 件共享、有 条 件共享、不 予 共享 英 文 名称:sharingType 数据 类型:字 符 型 值 域:无 条 件共享 为 1、有 条 件共享 为 2、不 予 共享 为 3 注 解:必 选项;最 大 出 现 次 数 1 8.10.2 共享条件 定义:不 同 共享 类型 的 信息资源 的共享 条 件 英 文 名称:sharingCondition 数据 类型:字 符 型 值 域:自 由文本 注 解:必 选项;最 大 出 现 次 数 1 8.10.3 共享方式 定义:获取信息资源 的方式 英 文 名称:sharingMode 数据 类型:字 符 型 值 域:自 由文本 注 解:必 选项;最 大 出 现 次 数 1 DB11/T 2268 2024 9 更新周 期 定义:对 信息资源 更 新 的 频率 英 文 名称:accessPeriodicity 数据 类型:字 符 型 值 域:自 由文本,如:实 时、每 日、每 周、每 月、每 季、每 年 等 注 解:必 选项;最 大 出 现 次 数 1 关联 资 源代码 定义:相关 联 资源 的 符 合 规范标 识 体系 的 代 码 英 文 名称:relationCode 数据 类型:字 符 型 值 域:自 由文本,如 该 信息资源同 属 于其 他资源 分 类 体系,需 要 标 注该 资源在 其 他 分 类 体系 中的 代码 注 解:可 选项;最 大 出 现 次 数 N 9 数据交换与共享方 法 身份认证 接口 调 用方(客 户 端)向 接口提 供 方(服 务 器)申请 接口 调 用 账 号,申请 成 功后,接口提 供 方 会 给 接口调 用方 一 个 app_id和 app_key。数据 整 理 对 需 要 共享的数据 利 用元数据进 行 定义、标 识、表示 及 允许值等 一 系 列 属性 描述,方 便 数据 对 象 在 不 同 部 门、不 同系统之间 进 行 流 通 和流 转,并 确保 流 转 过 程中数据标准的 一 致 性。数据 安全 在 乡 村 振兴大 数据共享的 过 程中 应 符 合 相关 法 律 法规的规定,应 采取 措 施 保证 数据的 有 序安 全 开放,如 根 据数据 等 级 对 传输 数据进 行 加密,防止 所 开放 的数据 被 泄密 或 篡 改,并 可对 加密 数据进 行 跟踪和 审 计。数据发布 数据 发 布 方法 如 下:a)数据提 供 方 使 用元数据定义数据元;b)定义数据 获取 接口;c)与共享中心 连 接;d)身 份验证 获取唯 一 标 识;e)携带 身 份 标 识,注 册 并 发 布 服 务 接口,完 成 数据接口 注 册 共享。数据 获取 数据 获取 方法 如 下:a)与共享中心 连 接,身 份验证,获取 身 份 标 识;b)携带 身 份 标 识,能 够 查 找 获 得 所 需 服 务 接口;DB11/T 2268 2024 10 c)按接口定义,调 用 服 务,获取 数据;d)数据 检 查、对 齐 后,反馈 结 果。10 数据接口方式 及说明 接口 描述 规范 10.1.1 接口 描述 规则 10.1.1.1 接口 服 务描述是 业 务 服 务 的 集 中 描述,包含 其 提 供 的 功 能 以 及 如 何 进 行 调 用;是在系统 发 布 的 服 务 提 供 方和 服 务 调 用方 之间 的规 约。10.1.1.2 接口 服 务描述 应 包含 对 各个 方 面 的 人 员 有 意 义并 可理 解 的 信息,接口 服 务描述 应 包含 概 要和 详细 服 务信息,使 用 平 台/技 术实 现 无 关 的语言进 行描述 应 以 业 务为 导 向。10.1.2 接口 描述 10.1.2.1 接口 服务 属性 接口 服 务 属性 是 业 务 接口 服 务 的 描述,它 提 供 组织和性 能 相关 要 求,是 接口 服 务 提 供 方和接口 服 务消费 方 之间 服 务协 议 的 依 据。定义 一 个 接口 服 务 应该 包含 的属性 如 下:服 务编码(必 选):能 体现 出接口 服 务 的业 务含 义的 唯 一 识 别 编码,应 遵 循 统 一 的 编码 规 则;接口 服 务 中文 名称(必 选):能 体现 接口 服 务 的 意 义,简 单 概 括,应少于 30个 汉 字;接口 服 务描述(必 选):清 晰 描述 接口 服 务 的业 务 功 能;服 务 提 供 方(必 选):提 供 此 接口 服 务 的业 务系统;服 务 消费 方(可 选):可 能 会 使 用 到此 接口 服 务 的业 务系统;服 务 等 级(必 选):分 为 紧急、普 通 和 低 级;报 文文件 名:指 请 求 报 文文件 名 和 响 应 报 文文件 名;数据 量(必 选):运行 期 间 单 次 访问 的数据 量 均值 和范围,比 如 均值 为 200K,范围 为 100K-300K;运行 效 率(可 选):单 次 访问 的 响 应 时间 均值 和范围;支 持 并 发(可 选):此 接口 可 支 持 的并 发 访问 量;是 否 可 重(可 选):接口 是 否能被 多 次重 试 调 用;超 时 说明(必 选):提 供 超 时时间 及 其 说明。返回 码 说明(必 选):业 务上需 提 供 返回 码 和 返回 信息给 服 务 消费 方;技 术方式(必 选):明 确 此 接口的 技 术方式;调 用说明(必 选):提 供 调 用 此 接口 服 务 的 必要条 件;安 全 要 求(必 选):描述 此 接口 服 务 的 安 全 要 求;接口 服 务 调 用 权 限(必 选):描述 该 接口 可 以 被 哪 些 系统 调 用,即 服 务 的 调 用 权 限。10.1.2.2 接口 服务 规 约 接口 服 务 规 约是 接口及参数的 技 术 描述,定义所 有 绑 定和 传输信息,以 及所 有 支 持 的 操 作及 相关输入、输 出的 格 式 等,应 以 XSD(XML Schema Definition)格 式 描述;Webservice协 议 应 以 WSDL(Web Services Description Language)形 式 存 在。接口 服 务 规 约 应 包括 详细 接口 服 务操 作 描述、数据 类型、消 息 格 式和结构、绑 定的 传输协 议 和 服 务 的位 置。DB11/T 2268 2024 11 10.1.3 接口 服务 实 现 规范 接口 服 务 实 现 应 遵 循 的规范 如 下:接口 服 务 命 名 应 遵 循 一 致 的 服 务 命 名 规范;接口 服 务 应 遵守统 一 的 报 文规范;接口 服 务 重 用 可适 当 提 高 接口的 颗粒 度;接口 服 务 的 设 计 和定义 可 与接口的实 现 分 阶段 进 行;接口 服 务 中 传输 的 报 文 要 求 应 是 经 过 校 验 的,符 合 业 务 规则的;接口 服 务 应 充 分考 虑 扩展性;接口 服 务 应 尽 可 能 通 用,避免 为 不 同系统 开发 不 同 接口 服 务。10.1.4 接口 服务检查 规范 接口 服 务 检 查 应 遵 循 以 下要 求:业 务 服 务 应 被 一 个以上 的流程 使 用;业 务 服 务 应 具 有 灵活 性和 完 整 性;业 务 服 务 应 与业 务相关 并 被 业 务 人 员 所 能 理 解;该 服 务在多 大 程 度 上 依赖 于其 它 业 务 服 务;该 服 务是 否 是 无 状态 的 服 务;该 服 务 的 描述是 否 和 其 它 服 务 的 描述相 冲突;是 否 有 类 似 或 重复 的 服 务 存 在。接口报文规范 10.2.1 报文 组织 格式 根 据 应 用 集 成 标准的 要 求,为 使 不 同 应 用 系统 能 够直 接 有 效 的进 行集 成,系统 应 使 用 json或 xml格式 报 文。不 同系统在传输协 议 上 的 报 文 格 式 应 统 一。json格 式和 xml格 式 两者 语义 应 等 价。10.2.2 XML报文规范 采 用 XML方式 传输 接口数据,XML报 文 应 满足 通 用性和扩展性 原 则,并 满足 业 务 的 各种需 要,方 便开发 人 员 应对不 断 变 化的业 务需 求。10.2.3 JSON报文规范 JSON数据交换语言 应 易 于人 的 阅 读 和 编 写,能 够 机 器 解析 和 生 成,可 有 效 提 升网络 传输 效 率。数据接口方式 乡 村 振兴大 数据 平 台 提 供 的数据接口方式 包括 但 不 限 于:文件接口:基 于 超 文本 传输 安 全协 议 HTTPS(Hypertext Transfer Protocol Secure)网络协 议 的 网络 服 务,以 电子 文件 形 式 传输 数据、交换 信息 的接口方式;API接口:基 于 HTTPS网络 协 议 的 网络 服 务,用 于 交换 主 体之间 通过 调 用 API接口 获取 数据 的接口方式。数据接口 说明 10.4.1 文件接口 DB11/T 2268 2024 12 10.4.1.1 文件接口 是 数据 需 求 方 获 得 数据 授权 后 由数据 服 务 平 台 为 其 提 供 的 下 载 端 口,通过 端 口 可直 接 获取 数据文件。10.4.1.2 文件接口说明 包括但不限于:a)文件 下 载 地 址:可 获取 到 数据文件的 URL地 址,URL一 般包括 模 式 或协 议、服 务 器 名称或 IP(互 联 网 协 议 地 址,Internet Protocol Address)地 址、路径 和文件 名 等;示例:协 议:/子 域名.域名.顶 级 域名:端 口 号/目 录/文件 名.文件 后 缀?参数=值#标 志。b)文件 类型:数据文件的 存 储 格 式说明;示例:rar文件。c)文件 大 小:数据文件的数据 量 描述;示例:10M。d)附 加 说明:数据文件的 其 他 说明。10.4.2 API接口 10.4.2.1 API接口 是 乡 村 振兴大 数据 平 台 中数据提 供 方、数据 获取 方分 别 共享和 获取 共享数据 集 的 服务 方式。10.4.2.2 接口参数 要 求如下:a)公 共参数 公 共参数 是 每 个 接口 都 要 携带 的参数,描述 每 个 接口的 基 本 信息,用 于 统计或 其 他 用 途,放 在 Header或 URL参数中。主要 参数及说明 见表 1。表 1 主 要 参 数 及说明 参数 说明 备 注 app_id 唯 一 标 识 用 户 ID app_id是全 局 唯 一 的,每 个 app_id将 对应一 个 客 户。app_key 加密 key app_key用 于 参数 签 名 使 用。timestamp 时间 戳 时间 戳,是 客 户 端调 用接口 时 对应 的 当 前 时间 戳,时间 戳 用 于 防 止 DoS攻击。request_id 请 求 ID 用 户 请 求 ID,是 客 户 端 随 机 生 成 的 值,要 保证 全 局 唯 一。sign 签 名 一 般 用 于 参数 签 名,防止 参数 被 非 法 篡 改。token 系统 调 用的 唯 一 凭 证 访问令牌 access token,用 于 接口中,用 于 标 识 接口 调 用 者 的 身 份、凭 证,减 少 用 户名 和 密 码 的 传输 次 数。一 般 token、timestamp、request_id和 sign 四 个 参数 会 在 接口中 同时 作 为 参数 传 递,每 个 参数 都有各 自 的用 途,其 中 首次 获取 token需 要 app_id、timestamp、request_id、sign,客 户 端 获取 token后 不 再 需 要 传 递 app_id。b)API参数 访问 接口 时 必要 的 或 可 选 的参数,应 说明参数的 名称、类型、是 否 必 填、示 例值 和 描述 说明 等 属性,参数 格 式 统 一 采 用 json格 式 在 header中 传 递。具 体 实 现 由数据提 供 方定义。10.4.2.3 API接口说明 如 下:a)接口标 识:赋 予 API接口的 唯 一 标 识;由 平 台 或 数据提 供 方 自 定义;b)接口 名称:接口 传输 的数据 核 心 内容 的 简 要、概况 性 描述,应 突 出数据 内容 指 向 的 对 象 以 及 对 象 具 有 的 显 著 特 征,如时间特 征、地域特 征、行 业 特 征 等,由数据提 供 方 自 定义;DB11/T 2268 2024 13 c)接口 描述:接口的 功 能 描述,由数据提 供 方 自 定义;d)接口 地 址:接口的 URL访问 地 址,由数据提 供 方 自 定义;e)请 求 方式:对 数据进 行操 作 采 用的 类型,可 采 用 GET或 POST等 方式;1)GET请 求 数据的接口 地 址 中参数 不应 直 接 使 用中文,如 果 在 URL中 使 用中文 必 须 统 一 转码;2)Post请 求 时需 要 在 请 求 的接口 地 址 中 包含 一 个 身 份验证 的 token,必 须 放 在 HTTPS请 求 Header中;f)请 求 参数:访问 接口 时 必要 的 或 可 选 的参数,应 说明参数的 名称、类型、是 否 必 填 等 属性,具体 实 现 由数据提 供 方 自 定义;g)返回 数据:请 求 数据 后,系统 返回 的 相关 结 果 数据。数据 包含 三 个 属性:状态 码(code)、信 息描述(message)、响 应 数据(data);h)状态 码:请 求 数据 后,系统 返回 的 状态 码 及 其 返回 说明,具 体 内容可 由 系统 开发 方 自 定义。示例:状态 码 描述 3004 请 求 参数 不 存 在 3005 请 求 过于 频 繁,请 稍 后 再试 3006 access_token参数 不 能 为 空 3007 该 IP已被 禁 用 3008 接口 需 要 授权 3009 接口 调 用 异常,请 稍 后 再试 3010 access_token令牌 无效 3011 该 数据 只允许 企 业用 户 调 用 3012 调 用 api网 关 失败,请 与 客服联 系 300 缺 少 名称 参数 301 未查询 到 数据 DB11/T 2268 2024 14 参考 文 献 1 GB/T 39477 2020 信息 安 全技 术 政 务信息 共享数据 安 全技 术 要 求 2 GB/T 26816 2011 信息资源 核 心元数据 3 GB/T 40094.3 2021 电子 商 务 数据交 易 第 3部分:数据接口规范 4 NY/T 3501 2019 农业数据共享 技 术规范