版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認領(lǐng)
文檔簡介
ICS35.240.60
A10
中華人民共和國國家標準
GB/TXXXXX—XXXX
電子商務數(shù)據(jù)交易平臺數(shù)據(jù)接口規(guī)范
E-commercedatatransactionplatform——
Specificationfordatainterface
(征求意見稿)
XXXX-XX-XX發(fā)布XXXX-XX-XX實施
GB/TXXXXX—XXXX
目??次
前言.................................................................................II
1范圍................................................................................1
2規(guī)范性引用文件......................................................................1
3術(shù)語、定義和縮略語..................................................................1
4數(shù)據(jù)接口類型........................................................................3
5數(shù)據(jù)獲取接口方式....................................................................3
6數(shù)據(jù)獲取接口說明....................................................................3
7數(shù)據(jù)接口內(nèi)容........................................................................6
I
GB/TXXXXX—XXXX
電子商務數(shù)據(jù)交易平臺數(shù)據(jù)接口規(guī)范
1范圍
本標準規(guī)定了電子商務數(shù)據(jù)交易平臺的數(shù)據(jù)接口類型、數(shù)據(jù)獲取接口方式、數(shù)據(jù)獲取接口說明和數(shù)
據(jù)接口內(nèi)容。
本標準適用于電子商務數(shù)據(jù)交易平臺的交易主體之間的數(shù)據(jù)傳輸獲取。
2規(guī)范性引用文件
下列文件對于本文件的應用是必不可少的。凡是注日期的引用文件,僅注日期的版本適用于本文件。
凡是不注日期的引用文件,其最新版本(包括所有的修改單)適用于本文件。
GB/T2260中華人民共和國行政區(qū)劃代碼
GB/T2659世界各國和地區(qū)名稱代碼
GB/T4754國民經(jīng)濟行業(yè)分類
GB/T4880.1語種名稱代碼第1部分:2字母代碼
GB/T4881中國語種代碼
GB/T5271.1信息技術(shù)詞匯第1部分:基本術(shù)語
GB/T7408數(shù)據(jù)元和交換格式信息交換日期和時間表示法(ISO8601:2000,IDT)
GB/T32670電子商務交易產(chǎn)品信息描述服裝
GB/T35408電子商務質(zhì)量管理術(shù)語
GB/TXXX電子商務數(shù)據(jù)交易數(shù)據(jù)描述規(guī)范
3術(shù)語、定義和縮略語
3.1術(shù)語和定義
下列術(shù)語和定義適用于本文件。
3.1.1
電子商務E-commerce
通過信息網(wǎng)絡進行產(chǎn)品和服務交易的經(jīng)營活動。
[GB/T35408,定義2.1.1]
3.1.2
數(shù)據(jù)data
信息的可再解釋的信息化表示,以適用于通信、解釋和處理。
注:一個概念模型表示人們對一個體系的理解。
[GB/T5271.1,定義01.01.02]
1
GB/TXXXXX—XXXX
3.1.3
電子商務數(shù)據(jù)交易平臺E-commercedatatransactionplatform
在電子商務模式下為交易雙方或多方提供數(shù)據(jù)交易撮合及相關(guān)服務的信息網(wǎng)絡系統(tǒng)。
3.1.4
交易主體transactionsubject
經(jīng)由電子商務數(shù)據(jù)交易平臺根據(jù)有關(guān)法律法規(guī)及電子商務數(shù)據(jù)交易平臺的有關(guān)規(guī)定審核批準,在電
子商務數(shù)據(jù)交易平臺進行數(shù)據(jù)交易的組織或個人。分為:
a)數(shù)據(jù)提供方:即賣方,利用電子商務數(shù)據(jù)交易平臺出售數(shù)據(jù)或提供服務;
b)數(shù)據(jù)需求方:即買方,利用電子商務數(shù)據(jù)交易平臺購買數(shù)據(jù)或獲取服務。
注:本標準只涉及數(shù)據(jù)交易,不包括服務交易。
3.1.5
數(shù)據(jù)提供方datasupplier
在電子商務數(shù)據(jù)交易中,擁有數(shù)據(jù)所有權(quán)或受數(shù)據(jù)所有者合法授權(quán)而獲得部分或全部權(quán)益的向平臺
提供交易數(shù)據(jù)的組織或個人。
3.1.6
數(shù)據(jù)需求方datademander
在電子商務數(shù)據(jù)交易中發(fā)布數(shù)據(jù)需求或搜索、購買數(shù)據(jù)的組織或個人。
3.1.7
數(shù)據(jù)文件datafile
用于電子商務數(shù)據(jù)交易平臺數(shù)據(jù)傳輸?shù)奈募?/p>
3.1.8
信息元素informationelement
信息的基本單元。
注1:與UML術(shù)語中的屬性同義。
注2:信息元素在信息實體中是唯一的。
[GB/T32670,定義3.4]
3.1.9
信息實體informationentity
一組說明數(shù)據(jù)相同特性的信息元素。
注1:與UML術(shù)語中的類同義。
注2:可以包含一個或一個以上信息實體。
[GB/T32670,定義3.5]
3.2縮略語
下列縮略語適用于本文件。
API應用程序編程接口(ApplicationProgrammingInterface)
2
GB/TXXXXX—XXXX
URL統(tǒng)一資源定位符(UniformResourceLocator)
4數(shù)據(jù)接口類型
平臺應提供一系列的接口,包括但不限于:
a)登錄接口(可授權(quán)第三方登錄);
b)身份認證接口;
c)目錄列表和查詢接口;
d)數(shù)據(jù)發(fā)布接口;
e)數(shù)據(jù)獲取接口;
f)支付接口。
本標準主要規(guī)范數(shù)據(jù)獲取接口的相關(guān)要求,其他接口的技術(shù)要求應遵循法律法規(guī)、國家標準的相關(guān)
規(guī)定。
5數(shù)據(jù)獲取接口方式
數(shù)據(jù)獲取接口方式包括但不限于:
a)文件接口:以電子文件形式傳輸數(shù)據(jù)、交換信息的接口方式;
b)API接口:基于http(超文本傳輸協(xié)議,HypertextTransferProtocol)或https(超文本傳輸安
全協(xié)議,HypertextTransferProtocolSecure)網(wǎng)絡協(xié)議的網(wǎng)絡服務,用于交易主體之間傳輸獲
取數(shù)據(jù)的接口方式。
6數(shù)據(jù)獲取接口說明
6.1文件接口
6.1.1概述
文件接口是數(shù)據(jù)需求方購買數(shù)據(jù)后由電子商務數(shù)據(jù)交易平臺為其提供的下載端口,通過端口可直接
獲取所購買的數(shù)據(jù)文件。
6.1.2接口說明
文件接口說明包括但不限于:
a)文件下載地址:可獲取到數(shù)據(jù)文件的URL地址;URL一般包括模式或協(xié)議、服務器名稱或IP
(互聯(lián)網(wǎng)協(xié)議地址,InternetProtocolAddress)地址、路徑和文件名等;
示例:協(xié)議://用戶名:密碼@子域名.域名.頂級域名:端口號/目錄/文件名.文件后綴?參數(shù)=值#標志
b)文件類型:數(shù)據(jù)文件的存儲格式說明;
示例:CSV文件
c)文件大小:數(shù)據(jù)文件的數(shù)據(jù)量描述;
示例:1000條
d)附加說明:數(shù)據(jù)文件的其他說明。
6.2API接口
6.2.1概述
3
GB/TXXXXX—XXXX
API接口是獲得所有數(shù)據(jù)集唯一訪問標識列表,數(shù)據(jù)需求方通過數(shù)據(jù)提供方定義的接口參數(shù)可獲取
到購買的數(shù)據(jù)。
6.2.2接口說明
API接口說明包括但不限于:
a)接口標識:賦予API接口的唯一標識;由平臺或數(shù)據(jù)提供方自定義;
示例:common_flowers
b)接口名稱:接口傳輸?shù)臄?shù)據(jù)核心內(nèi)容的簡要、概況性描述,應突出數(shù)據(jù)內(nèi)容指向的對象以及對
象具有的顯著特征,如時間特征、地域特征、行業(yè)特征等;由數(shù)據(jù)提供方自定義;
示例:常見花卉數(shù)據(jù)查詢
c)接口描述:接口的功能描述;由數(shù)據(jù)提供方自定義;
示例:接口提供常見花卉數(shù)據(jù)查詢,維度有名稱,拉丁名,別名,分類,科屬,盛花期,簡介
d)接口地址:接口的URL訪問地址;由數(shù)據(jù)提供方自定義;
示例:http://api.XXX/commonFlowers/query
e)請求方式:對數(shù)據(jù)進行操作采用的類型,可采用GET或POST等方式;由數(shù)據(jù)提供方自定義;
示例:httpGET
f)請求示例:請求數(shù)據(jù)的接口地址示例說明;由數(shù)據(jù)提供方自定義;
示例:http://api.XXX/commonFlowers/query?name=金錢兜&access_token=您申請的ACCESSTOKEN
g)請求參數(shù):訪問接口時必要的或可選的參數(shù),應說明參數(shù)的名稱、類型、是否必填、示例值和
描述說明等屬性;由數(shù)據(jù)提供方自定義;
示例:
名稱類型必填示例值描述
系統(tǒng)級別輸入?yún)?shù)
access_tokenString是-您申請的ACCESSTOKEN
應用級別輸入?yún)?shù)
nameString是金錢兜名稱
h)返回參數(shù):請求數(shù)據(jù)后,系統(tǒng)返回的相關(guān)參數(shù),應說明參數(shù)的名稱、類型、示例值和描述說明
等屬性;由數(shù)據(jù)提供方自定義;
示例:
系統(tǒng)級別返回參數(shù)
錯誤描述
Status狀態(tài)碼,200表示成功
Message返回信息
Data返回數(shù)據(jù)
應用級別返回參數(shù)
名稱類型示例值描述
statusString200返回狀態(tài)碼
messageString查詢成功狀態(tài)說明
nameString金錢兜名稱
latinNameStringPolysciasbalfourianaBailey拉丁名
aliasString圓葉南洋森、圓葉福祿桐、金錢多多別名
classificationString灌木花卉分類
4
GB/TXXXXX—XXXX
generaString植物界被子植物門科屬
floweringPeriodString秋季冬季盛花期
briefIntroductionString金錢兜因葉子像圓肚兜而得名簡介
i)返回示例:請求數(shù)據(jù)是否成功的返回示例;由數(shù)據(jù)提供方自定義;
示例:
{
"status":200,
"success":true,
"message":"查詢成功",
"data":[
{
"name":"金錢兜",
"latinName":"PolysciasbalfourianaBailey",
"alias":"圓葉南洋森、圓葉福祿桐、金錢多多",
"classification":"灌木花卉",
"genera":"植物界被子植物門雙子葉植物綱傘形目五加科南洋參屬",
"floweringPeriod":"秋季冬季",
"briefIntroduction":"金錢兜因葉子像圓肚兜而得名,又叫金錢多多,因樹葉圓形而呈兜狀,
稱作錢兜寓意吉祥富貴。在香港、臺灣是很受歡迎的室內(nèi)植物,金錢兜室內(nèi)養(yǎng)護要注意放在有散射光的地
方,一天中有一些陽光直射也可以。性喜高溫多濕,耐旱耐陰。姿態(tài)優(yōu)美,古色古香,適合布置于客廳、
庭園、花圃,亦可作盆景欣賞。主供盆栽,庭園樹及綠籬。接觸其汁液,可能引起發(fā)紅疹;碰到口部時,
有時會引起腫痛而無法吞咽。"
}
]
}
j)返回格式:返回信息中需要描述返回的狀態(tài)代碼,返回消息說明,附加的數(shù)據(jù)信息,如JSON
(JS對象簡譜,JavaScriptObjectNotation)格式;由數(shù)據(jù)提供方自定義;
k)錯誤碼參照:請求數(shù)據(jù)后,系統(tǒng)返回的錯誤碼及其返回說明。
示例:
系統(tǒng)級別錯誤碼錯誤描述
3004請求參數(shù)不存在
3005請求過于頻繁,請稍后再試
3006access_token參數(shù)不能為空
3007該IP已被禁用
3008接口需要付費,請充值
3009商家接口調(diào)用異常,請稍后再試
3010access_token令牌無效
3011該數(shù)據(jù)只允許企業(yè)用戶調(diào)用
3012調(diào)用api網(wǎng)關(guān)失敗,請與客服聯(lián)系
應用級別錯誤碼錯誤描述
300缺少名稱參數(shù)
5
GB/TXXXXX—XXXX
301未查詢到數(shù)據(jù)
7數(shù)據(jù)接口內(nèi)容
7.1描述規(guī)則
數(shù)據(jù)接口內(nèi)容的描述規(guī)則應遵循GB/TXXX《電子商務數(shù)據(jù)交易數(shù)據(jù)描述規(guī)范》中的相關(guān)規(guī)定。
7.2接口內(nèi)容
本標準規(guī)定的數(shù)據(jù)接口內(nèi)容包括但不限于查詢、發(fā)布、認證、獲取等接口涉及的內(nèi)容,見表1。
6
GB/TXXXXX—XXXX
表1數(shù)據(jù)接口內(nèi)容
序號中文名稱英文名稱說明數(shù)據(jù)類型及格式約束/條件同義詞值域計量單位備注
數(shù)據(jù)名稱應突出數(shù)據(jù)內(nèi)容指向的
交易數(shù)據(jù)在發(fā)布時采用對象以及對象具有的顯著特征,
1數(shù)據(jù)名稱datanameC..200M
的名稱如時間特征、地域特征、行業(yè)特
征等
描述交易數(shù)據(jù)內(nèi)容的核
2數(shù)據(jù)標簽datatagC..200M多個關(guān)鍵詞之間以空格隔開
心關(guān)鍵詞
交易數(shù)據(jù)定價采取的方可以按照數(shù)據(jù)使用量、使用時長、
3計費方式quotationmodeC..100O
式調(diào)用次數(shù)等參數(shù)進行計費
交易數(shù)據(jù)價值的量化價可根據(jù)交易數(shù)據(jù)的數(shù)據(jù)規(guī)模、使
4數(shù)據(jù)價格datapriceN..ul,2M人民幣元
格用次數(shù)、提供方式等制定價格
交易數(shù)據(jù)占據(jù)的存儲空KB、MB、
5數(shù)據(jù)規(guī)模datascaleC..200M
間大小、數(shù)據(jù)條數(shù)等條等
遵循GB/T4880.1
交易數(shù)據(jù)內(nèi)容采用的描對于文本型數(shù)據(jù)內(nèi)容該信息元素
6描述語種descriptionlanguageC..50C和GB/T4881中的
述語種的名稱為必備
規(guī)定
交易數(shù)據(jù)具有可被購買、
YYYYMMDD或遵循GB/T7408中
7有效期限validityperiod下載、使用或調(diào)用等屬性M
YYYY-MM-DD的規(guī)定
的有效截止日期
可以按照不同維度進行劃分,如
一些可區(qū)分的數(shù)據(jù)的集
按照數(shù)據(jù)交易形式可分為API、數(shù)
合,這種區(qū)別由這些數(shù)據(jù)
8數(shù)據(jù)種類datatypeC..200M據(jù)包等,按照數(shù)據(jù)應用領(lǐng)域可分
的性質(zhì)以及對這些數(shù)據(jù)
為政府數(shù)據(jù)、電商數(shù)據(jù)、金融數(shù)
的應用所表征
據(jù)等
7
GB/TXXXXX—XXXX
表1數(shù)據(jù)接口內(nèi)容(續(xù))
序號中文名稱英文名稱說明數(shù)據(jù)類型及格式約束/條件同義詞值域計量單位備注
數(shù)據(jù)在計算機內(nèi)部或外一般以擴展名表示,如“.txt”、
9數(shù)據(jù)存儲格式datastorageformat部存儲介質(zhì)上的記錄格C..200M“.doc”、“JPEG”、“AVI”
式等
對交易數(shù)據(jù)主題內(nèi)容的
10數(shù)據(jù)簡介dataprofileC..ulM
簡要描述
交易數(shù)據(jù)的來源,如政
11數(shù)據(jù)來源datasourcesC..200O
府、企業(yè)、個人等
交易數(shù)據(jù)適用的范圍、人
12數(shù)據(jù)用途datafunction群或應用的場景、業(yè)務及C..ulO
領(lǐng)域等方面的說明
交易數(shù)據(jù)所屬的國民經(jīng)遵循GB/T4754中
13所屬行業(yè)industryC..100O
濟行業(yè)的名稱的規(guī)定
遵循GB/T2659和
交易數(shù)據(jù)內(nèi)容所涉及到
14覆蓋地區(qū)administrativedivisionC..200OGB/T2260中的規(guī)
的行政區(qū)劃的名稱
定
交易數(shù)據(jù)交付成功采用主要包括線上傳輸、線下實體
15交付方式deliverymodeC..50M
的方法或途徑介質(zhì)拷貝、API接口調(diào)用等
數(shù)據(jù)所有權(quán)的歸屬信息
16版權(quán)說明copyrightdescriptionC..200M
說明
數(shù)據(jù)提供方對數(shù)據(jù)需求
17數(shù)據(jù)權(quán)限dataauthority方提出的數(shù)據(jù)行使權(quán)力C..ulM
的限制范圍
發(fā)布交易數(shù)據(jù)的機構(gòu)或本標準定義的發(fā)布者是指數(shù)據(jù)
18發(fā)布者publisherC..200M
個人的中文名稱提供方
8
GB/TXXXXX—XXXX
表1數(shù)據(jù)接口內(nèi)容(續(xù))
序號中文名稱英文名稱說明數(shù)據(jù)類型及格式約束/條件同義詞值域計量單位備注
YYYYMMDD或遵循GB/T7408中
19發(fā)布日期publishdate發(fā)布交易數(shù)據(jù)的日期O
YYYY-MM-DD的規(guī)定
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
- 6. 下載文件中如有侵權(quán)或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 單位人力資源管理制度精彩大全
- 醫(yī)療合作項目合同管理準則
- 高層住宅外墻清洗項目招投標
- 網(wǎng)絡營銷企業(yè)薪酬管理
- 居民區(qū)通風設(shè)備安裝合同
- 天津市養(yǎng)老社區(qū)物業(yè)醫(yī)療服務規(guī)范
- 紡織服裝弱電施工合同
- 廣東省廣州市天河區(qū)2023-2024學年高一上學期期末考試數(shù)學試卷(解析版)
- 羅定職業(yè)技術(shù)學院《田徑AⅡ》2023-2024學年第一學期期末試卷
- 酒店工程塔吊施工協(xié)議
- 新人教版四年級上冊《道德與法治》期末試卷【帶答案】
- MOOC 計算機網(wǎng)絡與應用-北京聯(lián)合大學 中國大學慕課答案
- 宣傳視頻拍攝服務投標技術(shù)方案技術(shù)標
- (2024年)中華人民共和國環(huán)境保護法全
- 建筑美學智慧樹知到期末考試答案2024年
- 2024平安保險測評題庫
- 商會成立籌備方案
- 2024年小學三年級英語家長會課件-(帶附加條款)
- 第22課+現(xiàn)代科技革命和產(chǎn)業(yè)發(fā)展(新教材課件)【中職專用】《世界歷史》(高教版2023基礎(chǔ)模塊)
- 司法鑒定規(guī)范化與新司法鑒定程序通則課件
- 自然資源保護法課件
評論
0/150
提交評論