版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
ICS35.240.60
A10
中华人民共和国国家标准
GB/TXXXXX—XXXX
电子商务数据交易平台数据接口规范
E-commercedatatransactionplatform——
Specificationfordatainterface
(征求意见稿)
XXXX-XX-XX发布XXXX-XX-XX实施
GB/TXXXXX—XXXX
目 次
前言.................................................................................II
1范围................................................................................1
2规范性引用文件......................................................................1
3术语、定义和缩略语..................................................................1
4数据接口类型........................................................................3
5数据获取接口方式....................................................................3
6数据获取接口说明....................................................................3
7数据接口内容........................................................................6
I
GB/TXXXXX—XXXX
电子商务数据交易平台数据接口规范
1范围
本标准规定了电子商务数据交易平台的数据接口类型、数据获取接口方式、数据获取接口说明和数
据接口内容。
本标准适用于电子商务数据交易平台的交易主体之间的数据传输获取。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅注日期的版本适用于本文件。
凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
GB/T2260中华人民共和国行政区划代码
GB/T2659世界各国和地区名称代码
GB/T4754国民经济行业分类
GB/T4880.1语种名称代码第1部分:2字母代码
GB/T4881中国语种代码
GB/T5271.1信息技术词汇第1部分:基本术语
GB/T7408数据元和交换格式信息交换日期和时间表示法(ISO8601:2000,IDT)
GB/T32670电子商务交易产品信息描述服装
GB/T35408电子商务质量管理术语
GB/TXXX电子商务数据交易数据描述规范
3术语、定义和缩略语
3.1术语和定义
下列术语和定义适用于本文件。
3.1.1
电子商务E-commerce
通过信息网络进行产品和服务交易的经营活动。
[GB/T35408,定义2.1.1]
3.1.2
数据data
信息的可再解释的信息化表示,以适用于通信、解释和处理。
注:一个概念模型表示人们对一个体系的理解。
[GB/T5271.1,定义01.01.02]
1
GB/TXXXXX—XXXX
3.1.3
电子商务数据交易平台E-commercedatatransactionplatform
在电子商务模式下为交易双方或多方提供数据交易撮合及相关服务的信息网络系统。
3.1.4
交易主体transactionsubject
经由电子商务数据交易平台根据有关法律法规及电子商务数据交易平台的有关规定审核批准,在电
子商务数据交易平台进行数据交易的组织或个人。分为:
a)数据提供方:即卖方,利用电子商务数据交易平台出售数据或提供服务;
b)数据需求方:即买方,利用电子商务数据交易平台购买数据或获取服务。
注:本标准只涉及数据交易,不包括服务交易。
3.1.5
数据提供方datasupplier
在电子商务数据交易中,拥有数据所有权或受数据所有者合法授权而获得部分或全部权益的向平台
提供交易数据的组织或个人。
3.1.6
数据需求方datademander
在电子商务数据交易中发布数据需求或搜索、购买数据的组织或个人。
3.1.7
数据文件datafile
用于电子商务数据交易平台数据传输的文件。
3.1.8
信息元素informationelement
信息的基本单元。
注1:与UML术语中的属性同义。
注2:信息元素在信息实体中是唯一的。
[GB/T32670,定义3.4]
3.1.9
信息实体informationentity
一组说明数据相同特性的信息元素。
注1:与UML术语中的类同义。
注2:可以包含一个或一个以上信息实体。
[GB/T32670,定义3.5]
3.2缩略语
下列缩略语适用于本文件。
API应用程序编程接口(ApplicationProgrammingInterface)
2
GB/TXXXXX—XXXX
URL统一资源定位符(UniformResourceLocator)
4数据接口类型
平台应提供一系列的接口,包括但不限于:
a)登录接口(可授权第三方登录);
b)身份认证接口;
c)目录列表和查询接口;
d)数据发布接口;
e)数据获取接口;
f)支付接口。
本标准主要规范数据获取接口的相关要求,其他接口的技术要求应遵循法律法规、国家标准的相关
规定。
5数据获取接口方式
数据获取接口方式包括但不限于:
a)文件接口:以电子文件形式传输数据、交换信息的接口方式;
b)API接口:基于http(超文本传输协议,HypertextTransferProtocol)或https(超文本传输安
全协议,HypertextTransferProtocolSecure)网络协议的网络服务,用于交易主体之间传输获
取数据的接口方式。
6数据获取接口说明
6.1文件接口
6.1.1概述
文件接口是数据需求方购买数据后由电子商务数据交易平台为其提供的下载端口,通过端口可直接
获取所购买的数据文件。
6.1.2接口说明
文件接口说明包括但不限于:
a)文件下载地址:可获取到数据文件的URL地址;URL一般包括模式或协议、服务器名称或IP
(互联网协议地址,InternetProtocolAddress)地址、路径和文件名等;
示例:协议://用户名:密码@子域名.域名.顶级域名:端口号/目录/文件名.文件后缀?参数=值#标志
b)文件类型:数据文件的存储格式说明;
示例:CSV文件
c)文件大小:数据文件的数据量描述;
示例:1000条
d)附加说明:数据文件的其他说明。
6.2API接口
6.2.1概述
3
GB/TXXXXX—XXXX
API接口是获得所有数据集唯一访问标识列表,数据需求方通过数据提供方定义的接口参数可获取
到购买的数据。
6.2.2接口说明
API接口说明包括但不限于:
a)接口标识:赋予API接口的唯一标识;由平台或数据提供方自定义;
示例:common_flowers
b)接口名称:接口传输的数据核心内容的简要、概况性描述,应突出数据内容指向的对象以及对
象具有的显著特征,如时间特征、地域特征、行业特征等;由数据提供方自定义;
示例:常见花卉数据查询
c)接口描述:接口的功能描述;由数据提供方自定义;
示例:接口提供常见花卉数据查询,维度有名称,拉丁名,别名,分类,科属,盛花期,简介
d)接口地址:接口的URL访问地址;由数据提供方自定义;
示例:http://api.XXX/commonFlowers/query
e)请求方式:对数据进行操作采用的类型,可采用GET或POST等方式;由数据提供方自定义;
示例:httpGET
f)请求示例:请求数据的接口地址示例说明;由数据提供方自定义;
示例:http://api.XXX/commonFlowers/query?name=金钱兜&access_token=您申请的ACCESSTOKEN
g)请求参数:访问接口时必要的或可选的参数,应说明参数的名称、类型、是否必填、示例值和
描述说明等属性;由数据提供方自定义;
示例:
名称类型必填示例值描述
系统级别输入参数
access_tokenString是-您申请的ACCESSTOKEN
应用级别输入参数
nameString是金钱兜名称
h)返回参数:请求数据后,系统返回的相关参数,应说明参数的名称、类型、示例值和描述说明
等属性;由数据提供方自定义;
示例:
系统级别返回参数
错误描述
Status状态码,200表示成功
Message返回信息
Data返回数据
应用级别返回参数
名称类型示例值描述
statusString200返回状态码
messageString查询成功状态说明
nameString金钱兜名称
latinNameStringPolysciasbalfourianaBailey拉丁名
aliasString圆叶南洋森、圆叶福禄桐、金钱多多别名
classificationString灌木花卉分类
4
GB/TXXXXX—XXXX
generaString植物界被子植物门科属
floweringPeriodString秋季冬季盛花期
briefIntroductionString金钱兜因叶子像圆肚兜而得名简介
i)返回示例:请求数据是否成功的返回示例;由数据提供方自定义;
示例:
{
"status":200,
"success":true,
"message":"查询成功",
"data":[
{
"name":"金钱兜",
"latinName":"PolysciasbalfourianaBailey",
"alias":"圆叶南洋森、圆叶福禄桐、金钱多多",
"classification":"灌木花卉",
"genera":"植物界被子植物门双子叶植物纲伞形目五加科南洋参属",
"floweringPeriod":"秋季冬季",
"briefIntroduction":"金钱兜因叶子像圆肚兜而得名,又叫金钱多多,因树叶圆形而呈兜状,
称作钱兜寓意吉祥富贵。在香港、台湾是很受欢迎的室内植物,金钱兜室内养护要注意放在有散射光的地
方,一天中有一些阳光直射也可以。性喜高温多湿,耐旱耐阴。姿态优美,古色古香,适合布置于客厅、
庭园、花圃,亦可作盆景欣赏。主供盆栽,庭园树及绿篱。接触其汁液,可能引起发红疹;碰到口部时,
有时会引起肿痛而无法吞咽。"
}
]
}
j)返回格式:返回信息中需要描述返回的状态代码,返回消息说明,附加的数据信息,如JSON
(JS对象简谱,JavaScriptObjectNotation)格式;由数据提供方自定义;
k)错误码参照:请求数据后,系统返回的错误码及其返回说明。
示例:
系统级别错误码错误描述
3004请求参数不存在
3005请求过于频繁,请稍后再试
3006access_token参数不能为空
3007该IP已被禁用
3008接口需要付费,请充值
3009商家接口调用异常,请稍后再试
3010access_token令牌无效
3011该数据只允许企业用户调用
3012调用api网关失败,请与客服联系
应用级别错误码错误描述
300缺少名称参数
5
GB/TXXXXX—XXXX
301未查询到数据
7数据接口内容
7.1描述规则
数据接口内容的描述规则应遵循GB/TXXX《电子商务数据交易数据描述规范》中的相关规定。
7.2接口内容
本标准规定的数据接口内容包括但不限于查询、发布、认证、获取等接口涉及的内容,见表1。
6
GB/TXXXXX—XXXX
表1数据接口内容
序号中文名称英文名称说明数据类型及格式约束/条件同义词值域计量单位备注
数据名称应突出数据内容指向的
交易数据在发布时采用对象以及对象具有的显著特征,
1数据名称datanameC..200M
的名称如时间特征、地域特征、行业特
征等
描述交易数据内容的核
2数据标签datatagC..200M多个关键词之间以空格隔开
心关键词
交易数据定价采取的方可以按照数据使用量、使用时长、
3计费方式quotationmodeC..100O
式调用次数等参数进行计费
交易数据价值的量化价可根据交易数据的数据规模、使
4数据价格datapriceN..ul,2M人民币元
格用次数、提供方式等制定价格
交易数据占据的存储空KB、MB、
5数据规模datascaleC..200M
间大小、数据条数等条等
遵循GB/T4880.1
交易数据内容采用的描对于文本型数据内容该信息元素
6描述语种descriptionlanguageC..50C和GB/T4881中的
述语种的名称为必备
规定
交易数据具有可被购买、
YYYYMMDD或遵循GB/T7408中
7有效期限validityperiod下载、使用或调用等属性M
YYYY-MM-DD的规定
的有效截止日期
可以按照不同维度进行划分,如
一些可区分的数据的集
按照数据交易形式可分为API、数
合,这种区别由这些数据
8数据种类datatypeC..200M据包等,按照数据应用领域可分
的性质以及对这些数据
为政府数据、电商数据、金融数
的应用所表征
据等
7
GB/TXXXXX—XXXX
表1数据接口内容(续)
序号中文名称英文名称说明数据类型及格式约束/条件同义词值域计量单位备注
数据在计算机内部或外一般以扩展名表示,如“.txt”、
9数据存储格式datastorageformat部存储介质上的记录格C..200M“.doc”、“JPEG”、“AVI”
式等
对交易数据主题内容的
10数据简介dataprofileC..ulM
简要描述
交易数据的来源,如政
11数据来源datasourcesC..200O
府、企业、个人等
交易数据适用的范围、人
12数据用途datafunction群或应用的场景、业务及C..ulO
领域等方面的说明
交易数据所属的国民经遵循GB/T4754中
13所属行业industryC..100O
济行业的名称的规定
遵循GB/T2659和
交易数据内容所涉及到
14覆盖地区administrativedivisionC..200OGB/T2260中的规
的行政区划的名称
定
交易数据交付成功采用主要包括线上传输、线下实体
15交付方式deliverymodeC..50M
的方法或途径介质拷贝、API接口调用等
数据所有权的归属信息
16版权说明copyrightdescriptionC..200M
说明
数据提供方对数据需求
17数据权限dataauthority方提出的数据行使权力C..ulM
的限制范围
发布交易数据的机构或本标准定义的发布者是指数据
18发布者publisherC..200M
个人的中文名称提供方
8
GB/TXXXXX—XXXX
表1数据接口内容(续)
序号中文名称英文名称说明数据类型及格式约束/条件同义词值域计量单位备注
YYYYMMDD或遵循GB/T7408中
19发布日期publishdate发布交易数据的日期O
YYYY-MM-DD的规定
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
评论
0/150
提交评论