鄉(xiāng)村振興大數(shù)據(jù)交換和共享規(guī)范

DBXX/TXXXX—XXXX

目次

前言............................................................................................................................................................II

1范圍.....................................................................................................................................................................1

2規(guī)范性引用文件................................................................................................................................................1

3術(shù)語和定義........................................................................................................................................................1

4數(shù)據(jù)交換與共享范圍........................................................................................................................................2

5交換和共享框架................................................................................................................................................2

6元數(shù)據(jù)屬性........................................................................................................................................................2

概述..............................................................................................................................................................2

屬性說明.....................................................................................................................................................2

7元數(shù)據(jù)擴(kuò)展........................................................................................................................................................3

元數(shù)據(jù)擴(kuò)展的原則.....................................................................................................................................4

元數(shù)據(jù)擴(kuò)展的類型.....................................................................................................................................4

元數(shù)據(jù)擴(kuò)展的實(shí)施.....................................................................................................................................4

元數(shù)據(jù)擴(kuò)展的報(bào)備.....................................................................................................................................4

8數(shù)據(jù)交換與共享元數(shù)據(jù)....................................................................................................................................5

概述..............................................................................................................................................................5

描述..............................................................................................................................................................5

9數(shù)據(jù)交換與共享方法........................................................................................................................................8

身份認(rèn)證.....................................................................................................................................................8

數(shù)據(jù)整理.....................................................................................................................................................8

數(shù)據(jù)安全.....................................................................................................................................................8

數(shù)據(jù)發(fā)布.....................................................................................................................................................8

數(shù)據(jù)獲取.....................................................................................................................................................8

10數(shù)據(jù)接口方式及說明......................................................................................................................................8

接口描述規(guī)范...........................................................................................................................................8

接口報(bào)文規(guī)范.........................................................................................................................................10

數(shù)據(jù)獲取接口方式.................................................................................................................................10

數(shù)據(jù)獲取接口說明.................................................................................................................................10

參考文獻(xiàn)..................................................................................................................................................13

I

DBXX/TXXXX—XXXX

前言

本文件按照GB/T1.1—2020《標(biāo)準(zhǔn)化工作導(dǎo)則第1部分：標(biāo)準(zhǔn)化文件的結(jié)構(gòu)和起草規(guī)則》的規(guī)定

起草。

本文件由北京市農(nóng)業(yè)農(nóng)村局提出并歸口。

本文件由北京市農(nóng)業(yè)農(nóng)村局組織實(shí)施。

本文件起草單位：

本文件主要起草人：

II

DBXX/TXXXX—XXXX

鄉(xiāng)村振興大數(shù)據(jù)交換和共享規(guī)范

1范圍

本文件規(guī)定了鄉(xiāng)村振興大數(shù)據(jù)交換與共享范圍、交換和共享框架、數(shù)據(jù)交換與共享的元數(shù)據(jù)屬性、

元數(shù)據(jù)擴(kuò)展、數(shù)據(jù)交換與共享元數(shù)據(jù)、數(shù)據(jù)交換與共享方法、數(shù)據(jù)接口方式及說明。

本標(biāo)準(zhǔn)適用于鄉(xiāng)村振興大數(shù)據(jù)交換和共享管理。

2規(guī)范性引用文件

下列文件中的內(nèi)容通過文中的規(guī)范性引用而構(gòu)成本文件必不可少的條款。其中，注日期的引用文件，

僅該日期對(duì)應(yīng)的版本適用于本文件；不注日期的引用文件，其最新版本（包括所有的修改單）適用于本

文件。

GB/T7408數(shù)據(jù)元和交換格式信息交換日期和時(shí)間表示法

GB/T26816信息資源核心元數(shù)據(jù)

GB/T40094.3電子商務(wù)數(shù)據(jù)交易第3部分：數(shù)據(jù)接口規(guī)范

NY/T3501農(nóng)業(yè)數(shù)據(jù)共享技術(shù)規(guī)范

3術(shù)語和定義

下列術(shù)語和定義適用于本文件。

元數(shù)據(jù)metadata

定義和描述其他數(shù)據(jù)的數(shù)據(jù)。

元數(shù)據(jù)元素metadataelement

元數(shù)據(jù)的基本單元。

注：元數(shù)據(jù)元素在元數(shù)據(jù)實(shí)體中是唯一的

元數(shù)據(jù)實(shí)體

一組說明信息資源相關(guān)特性的元數(shù)據(jù)元素。

注：可以包含一個(gè)或一個(gè)以上元數(shù)據(jù)實(shí)體。

數(shù)據(jù)交換與共享dataexchangeandsharing

1

DBXX/TXXXX—XXXX

實(shí)現(xiàn)不同地域、不同計(jì)算機(jī)、不同軟件的用戶獲取、交換非本機(jī)數(shù)據(jù)并進(jìn)行各種操作、運(yùn)算和分析

的過程。

數(shù)據(jù)接口datainterface

進(jìn)行數(shù)據(jù)傳輸時(shí)，數(shù)據(jù)提供方和接收方需遵守的接口約束或規(guī)定。

4數(shù)據(jù)交換與共享范圍

鄉(xiāng)村振興大數(shù)據(jù)交換和共享范圍如下：

——鄉(xiāng)村振興數(shù)據(jù)在農(nóng)業(yè)農(nóng)村局內(nèi)部現(xiàn)有相關(guān)應(yīng)用系統(tǒng)的數(shù)據(jù)交換與共享。

——鄉(xiāng)村振興數(shù)據(jù)與下屬各事業(yè)單位相關(guān)應(yīng)用系統(tǒng)之間的數(shù)據(jù)交換與共享。

——鄉(xiāng)村振興數(shù)據(jù)與農(nóng)業(yè)農(nóng)村部相關(guān)應(yīng)用系統(tǒng)之間的數(shù)據(jù)交換與共享。

——鄉(xiāng)村振興數(shù)據(jù)與其他橫向部門信息系統(tǒng)之間為了實(shí)現(xiàn)業(yè)務(wù)協(xié)同，進(jìn)行的數(shù)據(jù)交換與共享。

5交換和共享框架

鄉(xiāng)村振興大數(shù)據(jù)交換和共享主要流程為數(shù)據(jù)提供、數(shù)據(jù)交換和數(shù)據(jù)獲取三部分，具體流程見圖1。

圖1總體交換和共享框架

6元數(shù)據(jù)屬性

概述

采用摘要表示的方式定義和描述元數(shù)據(jù)，摘要內(nèi)容包括以下9個(gè)屬性：中文名稱、定義、英文名稱、

數(shù)據(jù)類型、值域、縮寫名、約束/條件、最大出現(xiàn)次數(shù)、備注。

屬性說明

6.2.1中文名稱

指元數(shù)據(jù)元素或元數(shù)據(jù)實(shí)體的中文名稱。

6.2.2定義

描述元數(shù)據(jù)實(shí)體或元數(shù)據(jù)元素的基本內(nèi)容，給出信息資源某個(gè)特性的解釋和說明。

6.2.3英文名稱

元數(shù)據(jù)實(shí)體或元素的英文名稱，一般用英文全稱。

2

DBXX/TXXXX—XXXX

所有組成詞匯為無縫連寫。元數(shù)據(jù)元素的首詞匯全部采用小寫字母，其余每個(gè)詞匯的首字母采用大

寫；元數(shù)據(jù)實(shí)體的每個(gè)詞匯的首字母大寫。

6.2.4數(shù)據(jù)類型

說明元數(shù)據(jù)元素或元數(shù)據(jù)實(shí)體的數(shù)據(jù)類型，對(duì)元數(shù)據(jù)元素的有效值域及允許的有效操作進(jìn)行了規(guī)定。

例如整型、實(shí)型、布爾型、字符串、日期型等。

6.2.5值域

規(guī)定了元數(shù)據(jù)元素的有效取值范圍。

6.2.6縮寫名

元數(shù)據(jù)元素或元數(shù)據(jù)實(shí)體的英文縮寫名稱?？s寫規(guī)則如下：

a)縮寫名在本標(biāo)準(zhǔn)范圍內(nèi)必須唯一；

b)縮寫名不應(yīng)包括任何空格、破折號(hào)、下劃線或分隔符等；

c)縮寫名不應(yīng)使用復(fù)數(shù)形式的英文單詞，除非該單詞本身就是復(fù)數(shù)形式，如“Goods”；

d)元數(shù)據(jù)實(shí)體縮寫名描述應(yīng)采用UCC方式，即每個(gè)英文單詞的首字母均大寫；元數(shù)據(jù)元素縮寫

名描述應(yīng)采用LCC方式，即除第一個(gè)英文單詞外，每個(gè)單詞的首字母大寫，并把這些單詞組

合起來；

e)對(duì)存在國際或行業(yè)領(lǐng)域慣用英文名稱縮寫的，采用慣用縮寫。

6.2.7約束/條件

元數(shù)據(jù)元素或元數(shù)據(jù)實(shí)體的約束/條件如下：

a)M：必選，表明該元數(shù)據(jù)元素或元數(shù)據(jù)實(shí)體必須選擇。

b)O：可選，根據(jù)實(shí)際應(yīng)用可以選擇也可以不選的元數(shù)據(jù)元素或元數(shù)據(jù)實(shí)體。已經(jīng)定義的可選元

數(shù)據(jù)元素和可選元數(shù)據(jù)實(shí)體，可指導(dǎo)部門元數(shù)據(jù)標(biāo)準(zhǔn)制定人員充分說明其信息。如果一個(gè)可

選元數(shù)據(jù)實(shí)體未被使用，則該實(shí)體所包含的元素（包括必選元素）也不選用?？蛇x元數(shù)據(jù)實(shí)

體可以有必選元素，但只當(dāng)可選實(shí)體被選用時(shí)才成為必選。

c)C：條件必選，當(dāng)滿足約束條件中所定義的條件時(shí)應(yīng)選擇。條件必選用于以下三種可能性

之一：

1)當(dāng)在多個(gè)選項(xiàng)中進(jìn)行選擇時(shí)，至少一個(gè)選項(xiàng)必選，且必須使用；

2)當(dāng)另一個(gè)元數(shù)據(jù)元素已經(jīng)使用時(shí)，選用一個(gè)元數(shù)據(jù)實(shí)體或元數(shù)據(jù)元素；

3)當(dāng)另一個(gè)元數(shù)據(jù)元素已經(jīng)選擇了一個(gè)特定值時(shí)，選用一個(gè)元數(shù)據(jù)元素。

6.2.8最大出現(xiàn)次數(shù)

說明元數(shù)據(jù)元素或元數(shù)據(jù)實(shí)體可以出現(xiàn)的最大實(shí)例數(shù)目。只出現(xiàn)一次的用“1”表示，多次重復(fù)出現(xiàn)

的用“N”表示。允許不為1的固定出現(xiàn)次數(shù)用相應(yīng)的整型數(shù)值表示，例如“2”、“3”、“4”等。

6.2.9備注

可根據(jù)需要對(duì)元數(shù)據(jù)元素或?qū)嶓w進(jìn)一步補(bǔ)充說明。

7元數(shù)據(jù)擴(kuò)展

3

DBXX/TXXXX—XXXX

元數(shù)據(jù)擴(kuò)展的原則

7.1.1選取元數(shù)據(jù)時(shí)，既要考慮數(shù)據(jù)資源單位的數(shù)據(jù)資源特點(diǎn)以及工作的復(fù)雜、難易程度，又要充分

滿足鄉(xiāng)村振興大數(shù)據(jù)的利用以及用戶查詢、提取數(shù)據(jù)的需要。

7.1.2選取的元數(shù)據(jù)不但要滿足鄉(xiāng)村振興大數(shù)據(jù)標(biāo)準(zhǔn)化需求，更應(yīng)該考慮將來一定時(shí)間內(nèi)可能產(chǎn)生的

標(biāo)準(zhǔn)化需求。擴(kuò)展過程中，可以積極參考國內(nèi)和國外先進(jìn)標(biāo)準(zhǔn)。

7.1.3新建的元數(shù)據(jù)不應(yīng)與第6章定義的元數(shù)據(jù)中的現(xiàn)有的元數(shù)據(jù)實(shí)體、元素、代碼表的名稱、定義

相沖突。

7.1.4增加的元數(shù)據(jù)元素應(yīng)按照第6章所確定的層次關(guān)系進(jìn)行合理的組織。如果第6章現(xiàn)有的元數(shù)據(jù)

實(shí)體無法滿足新增元數(shù)據(jù)的需要，則可以新建元數(shù)據(jù)實(shí)體。

7.1.5新建的元數(shù)據(jù)實(shí)體可以定義為復(fù)合元數(shù)據(jù)實(shí)體，即可以包含現(xiàn)有的和新建的元數(shù)據(jù)元素作為其

組成部分。

7.1.6允許以代碼表替代值域?yàn)樽杂晌谋镜默F(xiàn)有元數(shù)據(jù)元素的值域。

7.1.7允許增加現(xiàn)有代碼表中值的數(shù)量，擴(kuò)充后的代碼表應(yīng)與擴(kuò)充前的代碼表在邏輯上保持一致。

7.1.8允許對(duì)現(xiàn)有的元數(shù)據(jù)元素的值域進(jìn)行縮?。ɡ纾诘?章中中規(guī)定的某元數(shù)據(jù)元素的值域中

有7個(gè)值，在擴(kuò)展后可以規(guī)定它的值域只包含其中的4個(gè)值）。

7.1.9允許對(duì)現(xiàn)有的元數(shù)據(jù)的可選性和最大出現(xiàn)次數(shù)施以更嚴(yán)格的限制（例如，在第6章中定義為可

選的元數(shù)據(jù)，在擴(kuò)展后可以是必選的；定義為可無限次重復(fù)出現(xiàn)的元數(shù)據(jù)，在擴(kuò)展后可以是只能出現(xiàn)1

次）。

元數(shù)據(jù)擴(kuò)展的類型

信息資源在不同行業(yè)、不同地區(qū)的應(yīng)用需求可能存在變化，要根據(jù)需求在應(yīng)用中對(duì)本文件規(guī)定的元

數(shù)據(jù)進(jìn)行補(bǔ)充。在對(duì)本文件元數(shù)據(jù)內(nèi)容進(jìn)行擴(kuò)展時(shí)，應(yīng)包含第6章所定義的元數(shù)據(jù)，擴(kuò)展的類型如下：

a)擴(kuò)展元數(shù)據(jù)元素的值域；

b)增加新的元數(shù)據(jù)元素；

c)增加新的元數(shù)據(jù)實(shí)體類型；

d)對(duì)已有的元數(shù)據(jù)元素施加更嚴(yán)格的限定；

e)對(duì)已有元數(shù)據(jù)元素值域施加更多的限定；

f)創(chuàng)建新的元數(shù)據(jù)代碼表元素（擴(kuò)展代碼表）。

元數(shù)據(jù)擴(kuò)展的實(shí)施

7.3.1在擴(kuò)展元數(shù)據(jù)之前，應(yīng)仔細(xì)地查閱第6章中現(xiàn)有的元數(shù)據(jù)及其屬性，根據(jù)實(shí)際需求確認(rèn)是否缺

少適用的元數(shù)據(jù)。

7.3.2對(duì)于每一個(gè)增加的元數(shù)據(jù)，應(yīng)按照本標(biāo)準(zhǔn)第6章規(guī)定，采用摘要表示的方式，定義其中文名稱、

英文名稱、數(shù)據(jù)類型、值域、注解。

7.3.3對(duì)于新建的代碼表和代碼表元素，應(yīng)說明代碼表中每個(gè)值的名稱、代碼以及定義。

元數(shù)據(jù)擴(kuò)展的報(bào)備

7.4.1當(dāng)元數(shù)據(jù)內(nèi)容不能滿足用戶需求時(shí)，將相關(guān)的元數(shù)據(jù)標(biāo)準(zhǔn)文檔報(bào)農(nóng)業(yè)農(nóng)村局信息管理部門進(jìn)行

審核。審核通過后，可以按照上述方法擴(kuò)展。

7.4.2數(shù)據(jù)檢查、對(duì)齊后，返結(jié)果。

4

DBXX/TXXXX—XXXX

8數(shù)據(jù)交換與共享元數(shù)據(jù)

概述

數(shù)據(jù)交換共享元數(shù)據(jù)包括12個(gè)元數(shù)據(jù)實(shí)體及元數(shù)據(jù)元素，如下：

a)交換與共享數(shù)據(jù)名稱；

b)交換與共享數(shù)據(jù)代碼；

c)交換與共享數(shù)據(jù)來源；

d)交換與共享數(shù)據(jù)摘要；

e)交換與共享數(shù)據(jù)關(guān)鍵字；

f)交換與共享數(shù)據(jù)格式；

g)數(shù)據(jù)類型；

h)發(fā)布日期；

i)涉密情況；

j)共享屬性；

k)更新周期；

l)關(guān)聯(lián)資源代碼。

描述

8.2.1交換與共享數(shù)據(jù)名稱

定義：縮略交換與共享數(shù)據(jù)內(nèi)容的標(biāo)題

英文名稱：exchangandsharingDateName

數(shù)據(jù)類型：字符型

值域：自由文本

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)為1

8.2.2交換與共享數(shù)據(jù)代碼

定義：交換與共享數(shù)據(jù)唯一不變的標(biāo)識(shí)代碼

英文名稱：exchangandsharingDateCode

數(shù)據(jù)類型：字符型

值域：自由文本

注解：可選項(xiàng)；最大出現(xiàn)次數(shù)為1

8.2.3交換與共享數(shù)據(jù)來源

定義：說明數(shù)據(jù)與共享提供方及其聯(lián)系方式的信息

英文名稱：exchangandsharingDateSource

數(shù)據(jù)類型：復(fù)合型

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)為N

交換與共享數(shù)據(jù)提供方

定義：提供信息的單位

英文名稱：exchangandsharingDateProvider

數(shù)據(jù)類型：字符型

5

DBXX/TXXXX—XXXX

值域：自由文本

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)為1

交換與共享數(shù)據(jù)提供方聯(lián)系方式

定義：提供信息的單位聯(lián)系方式

英文名稱：providerTelephone

數(shù)據(jù)類型：字符型

值域：7～18位數(shù)字字符（包括企業(yè)或人員的固定聯(lián)系電話號(hào)碼，完整的電話包括國際區(qū)號(hào)、國內(nèi)

長途區(qū)號(hào)、本地電話號(hào)和分機(jī)號(hào)，之間用“-”分隔。）

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)為1

8.2.4交換與共享數(shù)據(jù)信息摘要

定義：對(duì)信息資源內(nèi)容的概要描述

英文名稱：exchangandsharingDateAbstract

數(shù)據(jù)類型：字符型

值域：自由文本

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)為1

8.2.5交換與共享數(shù)據(jù)關(guān)鍵字

定義：用于概況描述數(shù)據(jù)信息內(nèi)容的通用詞、形式化詞或短語

英文名稱：exchangandsharingDateKeywords

數(shù)據(jù)類型：字符型

值域：自由文本

注解：可選項(xiàng)；最大出現(xiàn)次數(shù)為1

8.2.6交換與共享數(shù)據(jù)格式

定義：信息資源的存在方式

英文名稱：exchangandsharingDateFormat

數(shù)據(jù)類型：字符型

值域：電子信息文檔、數(shù)據(jù)庫格式

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)為1

8.2.7數(shù)據(jù)類型

定義：標(biāo)明該信息項(xiàng)的數(shù)據(jù)類型

英文名稱：dataType

數(shù)據(jù)類型：字符型

值域：電子文檔數(shù)據(jù)存儲(chǔ)類型，見GB13000—2010

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)1

8.2.8發(fā)布日期

定義：信息資源提供方發(fā)布共享信息資源的日期

英文名稱：releaseDate

數(shù)據(jù)類型：日期型

6

DBXX/TXXXX—XXXX

值域：按GB/T7408—2005執(zhí)行，格式為CCYY-MM-DD

注解：可選項(xiàng)；最大出現(xiàn)次數(shù)1

8.2.9涉密情況

定義：對(duì)資源密級(jí)狀態(tài)的說明。

英文名稱：secretLevel

數(shù)據(jù)類型：字符型

值域：“公開”、“秘密”、“機(jī)密”、“絕密”

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)1

8.2.10共享屬性

定義：說明信息共享情況的信息

英文名稱：SharingRule

數(shù)據(jù)類型：復(fù)合型

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)1

共享類型

定義：信息資源的共享類型，包括無條件共享、有條件共享、不予共享

英文名稱：sharingType

數(shù)據(jù)類型：字符型

值域：無條件共享為1、有條件共享為2、不予共享為3

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)1

共享?xiàng)l件

定義：不同共享類型的信息資源的共享?xiàng)l件

英文名稱：sharingCondition

數(shù)據(jù)類型：字符型

值域：自由文本

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)1

共享方式

定義：獲取信息資源的方式

英文名稱：sharingMode

數(shù)據(jù)類型：字符型

值域：自由文本

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)1

8.2.11更新周期

定義：對(duì)信息資源更新的頻率

英文名稱：accessPeriodicity

數(shù)據(jù)類型：字符型

值域：自由文本，如：實(shí)時(shí)、每日、每周、每月、每季、每年等

注解：必選項(xiàng)；最大出現(xiàn)次數(shù)1

7

DBXX/TXXXX—XXXX

8.2.12關(guān)聯(lián)資源代碼

定義：相關(guān)聯(lián)資源的符合規(guī)范標(biāo)識(shí)體系的代碼

英文名稱：relationCode

數(shù)據(jù)類型：字符型

值域：自由文本，如該信息資源同屬于其他資源分類體系，需要標(biāo)注該資源在其他分類體系中的代

碼

注解：可選項(xiàng)；最大出現(xiàn)次數(shù)N

9數(shù)據(jù)交換與共享方法

身份認(rèn)證

接口調(diào)用方(客戶端)向接口提供方(服務(wù)器)申請(qǐng)接口調(diào)用賬號(hào)，申請(qǐng)成功后，接口提供方會(huì)給接

口調(diào)用方一個(gè)app_id和app_key。

數(shù)據(jù)整理

對(duì)需要共享的數(shù)據(jù)利用元數(shù)據(jù)進(jìn)行定義、標(biāo)識(shí)、表示及允許值等一系列屬性描述，方便數(shù)據(jù)對(duì)象在

不同部門、不同系統(tǒng)之間進(jìn)行流通和流轉(zhuǎn)，并確保流轉(zhuǎn)過程中數(shù)據(jù)標(biāo)準(zhǔn)的一致性。

數(shù)據(jù)安全

在鄉(xiāng)村振興大數(shù)據(jù)共享的過程中應(yīng)符合相關(guān)法律法規(guī)的規(guī)定，應(yīng)采取措施保證數(shù)據(jù)的有序安全開放，

如根據(jù)數(shù)據(jù)等級(jí)對(duì)傳輸數(shù)據(jù)進(jìn)行加密，防止所開放的數(shù)據(jù)被泄密或篡改，并可對(duì)加密數(shù)據(jù)進(jìn)行跟蹤和審

計(jì)。

數(shù)據(jù)發(fā)布

數(shù)據(jù)發(fā)布方法如下：

——數(shù)據(jù)提供方使用元數(shù)據(jù)定義數(shù)據(jù)元；

——定義數(shù)據(jù)獲取接口；

——與共享中心連接；

——身份驗(yàn)證獲取唯一標(biāo)識(shí)；

——攜帶身份標(biāo)識(shí)，注冊(cè)并發(fā)布服務(wù)接口,完成數(shù)據(jù)接口注冊(cè)共享。

數(shù)據(jù)獲取

數(shù)據(jù)獲取方法如下：

——與共享中心連接，身份驗(yàn)證，獲取身份標(biāo)識(shí)；

——攜帶身份標(biāo)識(shí)，能過查找獲得所需服務(wù)接口；

——按接口定義，調(diào)用服務(wù)，獲取數(shù)據(jù)；

——數(shù)據(jù)檢查、對(duì)齊后，返結(jié)果。

10數(shù)據(jù)接口方式及說明

接口描述規(guī)范

8

DBXX/TXXXX—XXXX

10.1.1接口描述規(guī)則

接口服務(wù)描述是業(yè)務(wù)服務(wù)的集中描述，包含其提供的功能以及如何進(jìn)行調(diào)用；是在系統(tǒng)發(fā)布的服務(wù)

提供方和服務(wù)調(diào)用方之間的規(guī)約。接口服務(wù)描述必須包含對(duì)各個(gè)方面的人員有意義并可理解的信息，接

口服務(wù)描述要包含概要和詳細(xì)服務(wù)信息，使用平臺(tái)/技術(shù)實(shí)現(xiàn)無關(guān)的語言進(jìn)行描述以業(yè)務(wù)為導(dǎo)向。

接口服務(wù)描述主要由2部分組成：接口服務(wù)屬性和接口服務(wù)規(guī)約。

接口服務(wù)屬性

接口服務(wù)屬性是業(yè)務(wù)接口服務(wù)的描述，它提供組織和性能相關(guān)要求，是接口服務(wù)提供方和接口服務(wù)

消費(fèi)方之間服務(wù)協(xié)議的依據(jù)。定義一個(gè)接口服務(wù)應(yīng)該包含的屬性如下所示：

——服務(wù)編碼（必選）：能體現(xiàn)出接口服務(wù)的業(yè)務(wù)含義的唯一識(shí)別編碼，應(yīng)遵循統(tǒng)一的編碼規(guī)則，

定義請(qǐng)參考交易服務(wù)代碼規(guī)范；

——接口服務(wù)中文名稱（必選）：能體現(xiàn)接口服務(wù)的意義，簡單概括，應(yīng)少于30個(gè)漢字；

——接口服務(wù)描述（必選）：清晰描述接口服務(wù)的業(yè)務(wù)功能；

——服務(wù)提供方（必選）：提供此接口服務(wù)的業(yè)務(wù)系統(tǒng)；

——服務(wù)消費(fèi)方（可選）：可能會(huì)使用到此接口服務(wù)的業(yè)務(wù)系統(tǒng)；

——服務(wù)等級(jí)（必選）：分為緊急、普通和低級(jí)；

——報(bào)文文件名：指請(qǐng)求報(bào)文文件名和響應(yīng)報(bào)文文件名；

——數(shù)據(jù)量（必選）：運(yùn)行期間單次訪問的數(shù)據(jù)量均值和范圍，比如均值為200K，范圍：100K-300K；

——運(yùn)行效率（可選）：單次訪問的響應(yīng)時(shí)間均值和范圍；

——支持并發(fā)（可選）：此接口可支持的并發(fā)訪問量；

——是否可重（可選）：接口是否能被多次重試調(diào)用；

——超時(shí)說明（必選）：提供超時(shí)時(shí)間及其說明。

——返回碼說明（必選）：業(yè)務(wù)上需提供返回碼和返回信息給服務(wù)消費(fèi)方。

——技術(shù)方式（必選）：明確此接口的技術(shù)方式；

——調(diào)用說明（必選）：提供調(diào)用此接口服務(wù)的必要條件。

——安全要求（必選）：描述此接口服務(wù)的安全要求。

——接口服務(wù)調(diào)用權(quán)限（必選）：描述此接口服務(wù)的調(diào)用權(quán)限。

——描述該接口可以被哪些系統(tǒng)調(diào)用，即服務(wù)的調(diào)用權(quán)限。

接口服務(wù)規(guī)約

接口服務(wù)規(guī)約是接口及參數(shù)的技術(shù)描述，定義所有綁定和傳輸信息，以及所有支持的操作及相關(guān)輸

入、輸出的格式等以XSD格式描述；而Webservice協(xié)議通常以WSDL形式存在，被稱為服務(wù)WSDL。接口

服務(wù)規(guī)約包含：詳細(xì)接口服務(wù)操作描述、數(shù)據(jù)類型、消息格式和結(jié)構(gòu)、綁定的傳輸協(xié)議和服務(wù)的位置。

10.1.2接口服務(wù)實(shí)現(xiàn)規(guī)范

接口服務(wù)實(shí)現(xiàn)需要遵循的規(guī)范如下：

——接口服務(wù)命名要遵循一致的服務(wù)命名規(guī)范；

——接口服務(wù)應(yīng)該遵守統(tǒng)一的報(bào)文規(guī)范；

——接口服務(wù)為了重用可以適當(dāng)提高接口的顆粒度；

——接口服務(wù)的設(shè)計(jì)和定義應(yīng)該與接口的實(shí)現(xiàn)分階段進(jìn)行；

——接口服務(wù)中傳輸?shù)膱?bào)文要求都是經(jīng)過校驗(yàn)的，符合業(yè)務(wù)規(guī)則的，否則不符合報(bào)文會(huì)被返回；

——接口服務(wù)應(yīng)充分考慮到擴(kuò)展性，例如在定義數(shù)據(jù)結(jié)構(gòu)時(shí)多個(gè)字段封裝為一個(gè)可擴(kuò)展的對(duì)象；

9

DBXX/TXXXX—XXXX

——接口服務(wù)應(yīng)盡可能通用，對(duì)于同一業(yè)務(wù)對(duì)象，應(yīng)避免為不同系統(tǒng)開發(fā)不同接口服務(wù)。

10.1.3接口服務(wù)檢查規(guī)范

接口服務(wù)抽取后要對(duì)服務(wù)的交互進(jìn)行檢查，通過此檢查來發(fā)現(xiàn)該接口服務(wù)是否合理。以下列出的是

對(duì)接口服務(wù)進(jìn)行檢查的指導(dǎo)性原則，這些原則在運(yùn)用的時(shí)候可以根據(jù)具體的項(xiàng)目情況進(jìn)行裁減和選擇。

——業(yè)務(wù)服務(wù)能否可以被一個(gè)以上的流程使用；

——業(yè)務(wù)服務(wù)是否是靈活和完整的；

——業(yè)務(wù)服務(wù)是否是與業(yè)務(wù)相關(guān)、有業(yè)務(wù)含義并被業(yè)務(wù)人員所能理解的；

——該服務(wù)在多大程度上依賴于其它業(yè)務(wù)服務(wù)；

——該服務(wù)是否是無狀態(tài)的服務(wù)；

——該服務(wù)的描述是否和其它服務(wù)的描述相沖突；

——是否沒有類似或重復(fù)的服務(wù)存在。

接口報(bào)文規(guī)范

10.2.1報(bào)文組織格式

根據(jù)應(yīng)用集成標(biāo)準(zhǔn)的要求，為使不同應(yīng)用系統(tǒng)能夠直接有效的進(jìn)行集成，系統(tǒng)主要使用json或xml

格式報(bào)文。無論在何種傳輸協(xié)議上，不同系統(tǒng)之間面對(duì)的報(bào)文格式需要統(tǒng)一。無論是json格式還是xml

格式，兩者語義必須等價(jià)。

10.2.2XML報(bào)文規(guī)范

采用XML方式來傳輸接口數(shù)據(jù)，XML報(bào)文滿足通用性和擴(kuò)展性原則，能滿足業(yè)務(wù)的各種需要，而且

方便開發(fā)人員應(yīng)對(duì)不斷變化的業(yè)務(wù)需求，方便新交易的開發(fā)。

10.2.3JSON報(bào)文規(guī)范

JSON是一種輕量級(jí)的數(shù)據(jù)交換格式，它基于ECMAScript的一個(gè)子集，采用完全獨(dú)立于編程語言的

文本格式來存儲(chǔ)和表示數(shù)據(jù)。JSON數(shù)據(jù)交換語言應(yīng)易于人閱讀和編寫，同時(shí)也易于機(jī)器解析和生成，

并有效地提升網(wǎng)絡(luò)傳輸效率。

數(shù)據(jù)獲取接口方式

數(shù)據(jù)獲取接口方式包括但不限于：

——文件接口：以電子文件形式傳輸數(shù)據(jù)、交換信息的接口方式；

——API接口：https（超文本傳輸安全協(xié)議，HypertextTransferProtocolSecure）網(wǎng)絡(luò)協(xié)議的網(wǎng)絡(luò)服

務(wù)，用于交易主體之間傳輸獲取數(shù)據(jù)的接口方式。

數(shù)據(jù)獲取接口說明

10.4.1文件接口

概述

文件接口是數(shù)據(jù)需求方獲得數(shù)據(jù)授權(quán)后由數(shù)據(jù)服務(wù)平臺(tái)為其提供的下載端口，通過端口可直接獲取

數(shù)據(jù)文件。

接口說明

10

DBXX/TXXXX—XXXX

文件接口說明包括但不限于：

a)文件下載地址：可獲取到數(shù)據(jù)文件的URL地址；URL一般包括模式或協(xié)議、服務(wù)器名稱或IP

（互聯(lián)網(wǎng)協(xié)議地址，InternetProtocolAddress）地址、路徑和文件名等；

示例：協(xié)議：//子域名.域名.頂級(jí)域名:端口號(hào)/目錄/文件名.文件后綴?參數(shù)=值#標(biāo)志

b)文件類型：數(shù)據(jù)文件的存儲(chǔ)格式說明；

示例：rar文件

c)文件大?。簲?shù)據(jù)文件的數(shù)據(jù)量描述；

示例：10M

d)附加說明：數(shù)據(jù)文件的其他說明。

10.4.2API接口

概述

API接口是鄉(xiāng)村振興大數(shù)據(jù)平臺(tái)中數(shù)據(jù)提供方、數(shù)據(jù)獲取方分別共享和獲取共享數(shù)據(jù)集的服務(wù)方式。

接口參數(shù)

接口參數(shù)要求如下：

a)公共參數(shù)

公共參數(shù)是每個(gè)接口都要攜帶的參數(shù)，描述每個(gè)接口的基本信息，用于統(tǒng)計(jì)或其他用途，放在Header

或url參數(shù)中。主要參數(shù)及說明見表1。

表1主要參數(shù)及說明

參數(shù)說明備注

app_id唯一標(biāo)識(shí)用戶IDapp_id是全局唯一的，每個(gè)app_id將對(duì)應(yīng)一個(gè)客戶

app_key加密keyapp_key用于參數(shù)簽名使用。

時(shí)間戳，是客戶端調(diào)用接口時(shí)對(duì)應(yīng)的當(dāng)前時(shí)間戳，時(shí)間戳用于防止

timestamp時(shí)間戳

DoS攻擊。

request_id請(qǐng)求ID用戶請(qǐng)求ID，是客戶端隨機(jī)生成的值,要保證全局唯一。

sign簽名一般用于參數(shù)簽名，防止參數(shù)被非法篡改。

訪問令牌accesstoken,用于接口中,用于標(biāo)識(shí)接口調(diào)用者的身份、

token系統(tǒng)調(diào)用的唯一憑證

憑證，減少用戶名和密碼的傳輸次數(shù)。

一般token、timestamp、request_id和sign四個(gè)參數(shù)會(huì)在接口中會(huì)同時(shí)作為參數(shù)傳遞，每個(gè)參數(shù)都有

各自的用途，其中首次獲取token需要app_id、timestamp、request_id、sign，客戶端獲取token后不再需要

傳遞app_id。

b)API參數(shù)

訪問接口時(shí)必要的或可選的參數(shù)，應(yīng)說明參數(shù)的名稱、類型、是否必填、示例值和描述說明等屬性，

參數(shù)格式統(tǒng)一采用json格式在header中傳遞。具體實(shí)現(xiàn)由數(shù)據(jù)提供方定義。

接口說明

API接口說明包括但不限于：

a)接口標(biāo)識(shí)：賦予API接口的唯一標(biāo)識(shí)；由平臺(tái)或數(shù)據(jù)提供方自定義；

11

DBXX/TXXXX—XXXX

b)接口名稱：接口傳輸?shù)臄?shù)據(jù)核心內(nèi)容的簡要、概況性描述，應(yīng)突出數(shù)據(jù)內(nèi)容指向的對(duì)象以及

對(duì)象具有的顯著特征，如時(shí)間特征、地域特征、行業(yè)特征等；由數(shù)據(jù)提供方自定義；

c)接口描述：接口的功能描述；由數(shù)據(jù)提供方自定義；

d)接口地址：接口的URL訪問地址；由數(shù)據(jù)提供方自定義；

e)請(qǐng)求方式：對(duì)數(shù)據(jù)進(jìn)行操作采用的類型，可采用GET或POST等方式；

1)GET請(qǐng)求數(shù)據(jù)的接口地址中參數(shù)禁止直接使用中文，如果在URL中使用中文必須統(tǒng)一轉(zhuǎn)

碼。

2)Post請(qǐng)求數(shù)據(jù)的接口地址中除調(diào)用身份參數(shù)token直接在Header或RUL中。

3)請(qǐng)求參數(shù)：訪問接口時(shí)必要的或可選的參數(shù)，應(yīng)說明參數(shù)的名稱、類型、是否必填等屬

性；具體實(shí)現(xiàn)由數(shù)據(jù)提供方自定義。

f)返回?cái)?shù)據(jù)：請(qǐng)求數(shù)據(jù)后，系統(tǒng)返回的相關(guān)結(jié)果數(shù)據(jù)。數(shù)據(jù)包含三個(gè)屬性：狀態(tài)碼（code）、信

息描述（message）、響應(yīng)數(shù)據(jù)（data）。

g)錯(cuò)誤碼參照：請(qǐng)求數(shù)據(jù)后，系統(tǒng)返回的錯(cuò)誤碼及其返回說明?？蛻舳烁鶕?jù)狀態(tài)碼及信息描述

可快速知道接口，如果狀態(tài)碼返回成功，再開始處理數(shù)據(jù)。由系統(tǒng)開發(fā)方自定義。

示例：

錯(cuò)誤碼錯(cuò)誤描述

3004請(qǐng)求參數(shù)不存在

3005請(qǐng)求過于頻繁，請(qǐng)稍后再試

3006access_token參數(shù)不能為空

3007該IP已被禁用

3008接口需要授權(quán)

3009接口調(diào)用異常，請(qǐng)稍后再試

3010access_token令牌無效

3011該數(shù)據(jù)只允許企業(yè)用戶調(diào)用

3012調(diào)用api網(wǎng)關(guān)失敗，請(qǐng)與客服聯(lián)系

300缺少名稱參數(shù)

301未查詢到數(shù)據(jù)

12

DBXX/TXXXX—XXXX

參考文獻(xiàn)

[1]GB/T39477—2020信息安全技術(shù)政務(wù)信息共享數(shù)據(jù)安全技術(shù)要求

[2]DB43/T1754—2020政務(wù)大數(shù)據(jù)中心數(shù)據(jù)交換規(guī)范

13

ICS65.020.99

CCSB04

11

北京市地方標(biāo)準(zhǔn)

DBXX/TXXXX—XXXX

鄉(xiāng)村振興大數(shù)據(jù)交換和共享規(guī)范

Bigdataforruralrevitalization—Dataexchangeandsharingstandard

（征求意見稿）

-XX-XX發(fā)布XXXX-XX-XX實(shí)施

北京市市場監(jiān)督管理局??發(fā)布

DBXX/TXXXX—XXXX

鄉(xiāng)村振興大數(shù)據(jù)交換和共享規(guī)范

1范圍

本文件規(guī)定了鄉(xiāng)村振興大數(shù)據(jù)交換與共享范圍、交換和共享框架、數(shù)據(jù)交換與共享的元數(shù)據(jù)屬性、

元數(shù)據(jù)擴(kuò)展、數(shù)據(jù)交換與共享元數(shù)據(jù)、數(shù)據(jù)交換與共享方法、數(shù)據(jù)接口方式及說明。

本標(biāo)準(zhǔn)適用于鄉(xiāng)村振興大數(shù)據(jù)交換和共享管理。

2規(guī)范性引用文件

下列文件中的內(nèi)容通過文中的規(guī)范性引用而構(gòu)成本文件必不可少的條款。其中，注日期的引用文件，

僅該日期對(duì)應(yīng)的版本適用于本文件；不注日期的引用文件，其最新版本（包括所有的修改單）適用于本

文件。

GB/T7408數(shù)據(jù)元和交換格式信息交換日期和時(shí)間表示法

GB/T26816信息資源核心元數(shù)據(jù)

GB/T40094.3電子商務(wù)數(shù)據(jù)交易第3部分：數(shù)據(jù)接口規(guī)范

NY/T3501農(nóng)業(yè)數(shù)據(jù)共享技術(shù)規(guī)范

3術(shù)語和定義

下列術(shù)語和定義適用于本文件。

元數(shù)據(jù)metadata

定義和描述其他數(shù)據(jù)的數(shù)據(jù)。

元數(shù)據(jù)元素metadataelement

元數(shù)據(jù)的基本單元。

注：元數(shù)據(jù)元素在元數(shù)據(jù)實(shí)