DB15/T 3486.4-2024 内蒙古北斗高分综合应用服务平台 第4部分:数据接口
DB15/T 3486.4-2024 Inner Mongolia Beidou High-Precision Integrated Application Service Platform Part 4: Data Interface
基本信息
发布历史
-
2024年06月
文前页预览
研制信息
- 起草单位:
- 起草人:
- 出版信息:
- 页数:22页 | 字数:- | 开本: -
内容描述
ICS35.080
CCSL78
15
内蒙古自治区地方标准
DB15/T3486.4—2024
内蒙古北斗高分综合应用服务平台
第4部分:数据接口
InnermongoliaBeidouGaofencomprehensiveapplicationservice
platformPart4:Datainterface
2024-06-14发布2024-07-14实施
内蒙古自治区市场监督管理局发布
DB15/T3486.4—2024
目次
前言II
引言III
1范围1
2规范性引用文件1
3术语和定义1
4缩略语1
5数据接口1
Web访问接口1
数据推送接口2
6数据接口开发要求2
调用方式2
请求报文举例2
响应报文举例2
调用权限控制2
7接口说明3
用户信息对接接口3
机构管理4
终端操作7
终端位置信息管理12
I
DB15/T3486.4—2024
前言
本文件按照GB/T1.1—2020《标准化工作导则第1部分:标准化文件的结构和起草规则》的规定
起草。
本文件是DB15/T3486《内蒙古北斗高分综合应用服务平台》的第4部分。DB15/T3486已经发布了
以下部分:
——第1部分:功能描述
——第2部分:短报文数据传输协议;
——第3部分:4G数据传输协议;
——第4部分:数据接口;
——第5部分:高分服务二次开发要求;
——第6部分:安全要求。
本文件由中共内蒙古自治区委员会军民融合发展委员会办公室提出。
本文件由内蒙古自治区军民融合标准化技术委员会(SAM/TC57)归口。
本文件起草单位:内蒙古自治区军民融合发展研究中心、航天恒星科技有限公司、内蒙古卫星应用
产业协会、内蒙古自治区知识产权保护中心、内蒙古自治区大数据中心。
本文件主要起草人:王伟、孟斌、刘贺、吴凯、崔涛、苏明明、郭稚鹰、王雯铎、任淑慧、郭嘉丽、
李申阳、史欣赫、史凌峰、董国栋、袁鹏、张静、张建军、石彦龙。
II
DB15/T3486.4—2024
引言
制定北斗高分综合应用服务平台功能描述、数据传输协议、数据接口、二次开发和安全要求系列标
准有助于构建一个功能丰富、安全可信、易于集成和拓展的北斗高分综合应用服务平台,推动相关产业
的快速发展,提高用户体验,促进创新。北斗高分综合应用服务平台系列标准由六部分构成。
——第1部分:功能描述。有助于确保不同组件和模块之间的功能一致性,避免因不同开发者理
解不同而导致的功能差异。明确的功能描述可以提高开发人员的理解和实现的一致性。有助
于提供一致的用户体验。无论用户使用平台的哪一部分,他们都能够期望相似的功能和操作
方式,降低了学习成本和提高了用户满意度。
——第2部分:短报文数据传输协议。制定短报文数据传输协议标准确保不同组件和模块之间能
够进行有效的数据交换,提高了平台的互操作性。这对于整合不同数据源、设备和服务至关
重要。
——第3部分:4G数据传输协议。优化的数据传输协议可以提高数据传输效率,减少网络带宽的
占用,加速数据处理和分析的过程。
——第4部分:数据接口。定义统一的数据接口标准有助于不同组件和系统之间实现更加顺畅的
数据交互,提高平台的互操作性,支持各类数据的集成与共享。
——第5部分:高分服务二次开发要求。制定二次开发标准有助于构建健康的开发生态系统。标
准化的开发接口和工具使得第三方开发者更容易参与平台的生态系统,从而促进创新和市场
竞争。明确的二次开发标准降低了开发者的学习成本,加速了应用程序和服务的开发周期。
——第6部分:安全要求。制定安全要求标准有助于确保平台对于数据和用户隐私的处理是安全
可靠的。这对于用户信任的建立至关重要,也有助于维护平台的声誉。
III
DB15/T3486.4—2024
内蒙古北斗高分综合应用服务平台
第4部分:数据接口
1范围
本文件规定了内蒙古北斗高分综合应用服务平台不同功能模块间的数据接口、数据接口开发要求
及接口说明。
本文件适用于内蒙古北斗高分综合应用服务平台(以下简称平台)的接口设计。
2规范性引用文件
下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,
仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本
文件。
GB/T11457信息技术软件工程术语
GB/T25070信息安全技术网络安全等级保护安全设计技术要求
3术语和定义
GB/T11457、GB/T25070界定的以及下列术语和定义适用于本文件。
数据接口datainterface
提供异构数据源统一标准化的数据对外应用开发接口服务,满足个性化数据需求。
注:数据接口分为WEB访问接口、数据推送接口。
4缩略语
下列缩略语适用于本文件。
ID:身份标识号缩写,具有唯一性(Identitydocument)
IMEI:国际移动设备识别码,即设备序列号,具有唯一性(Internationalmobileequipment
identity)
5数据接口
Web访问接口
Web访问接口为业务系统中的数据需求提供数据服务支持。通过标准协议和个性化参数来满足各业
务系统的数据需求。整个WEB访问接口基于大数据基础支撑组件并采用分布式架构,提供跨编程语言、
1
DB15/T3486.4—2024
跨操作系统平台的远程调用,向外界提供一系列能通过Web调用的API接口实现其他业务应用调用,满足
内蒙古北斗高分行业其他业务需求。
数据推送接口
通过利用消息队列构建业务数据推送接口服务,同时针对不同的场景可用采用不同的推送模式,满
足个性化推送需求。为了提升推送的到达率,可通过服务发起多种类型的消息推送,用户可根据实际的
业务场景,选择合适的推送内容、推送渠道以及推送方式。
6数据接口开发要求
调用方式
支持如下HTTP调用方式:
a)PUT:更新资源,请求消息必须包含资源中的部分或所有成员;
b)POST:创建资源,请求消息必须包含资源中的一个成员;
c)GET:请求指定的资源信息;
d)DELETE:删除一个或所有支持post方法的资源成员。
请求报文举例
当方法是PUT/POST时,HTTP主体通常需要包含JSON数据。请求必须发送到服务端的HTTP/HTTPS端口。
响应报文举例
响应报文举例如下:
a)“URL”:代表HTTP请求消息携带的URL。求方法为get/put/delete时,URL与请求中的URL
相同。post请求,它是新创建对象的URL。客户端可以使用它直接获取新对象;
b)“CreatedID”:代表资源支持httppost/delete方法。它将传输新对象的ID,该ID由服务
器为新对象创建;
c)“Code”:代表处理系统结果,表1常见状态码说明;
d)“msg”:代表处理系统结果的解释;
e)“Data”:请求(获取)的资源的信息或数据。大多数情况下都是JSON。对于相同的URL,放
置请求数据格式与getresponse中的数据相同。如果服务器工作失败,或者HTTP方法为
Put/Post,则响应“data"包含”null"。
表1常见状态码说明
状态码状态码说明备注
200访问服务器成功
404请求访问的资源在服务器上不存在
403访问被拒绝,当前主机没有权限
405访问的服务器不支持当前请求所用的方法
500访问的服务器出现内部错误
504访问的服务器负载比较大,可能会导致出现超时的情况
302访问的服务器临时重定向,临时需要跳转到其他页面
301访问的服务器永久重定向,永久性的跳转到其他页面
调用权限控制
2
DB15/T3486.4—2024
调用接口前需获取Token,并在请求头参数中包含“X-Access-Token”参数,否则调用失败。
7接口说明
用户信息对接接口
7.1.1获取用户信息
请求url:/user/getUserInfoByToken。
请求方式:POST。
调用量上限(次/日):500。
请求头参数见表2,接口返回参数见表3,data参数示例见表4。
表2获取用户信息请求头参数
参数名称参数说明备注
X-Access-Tokentoken
app请求头中是否有app;有,则是app端访问否则是web端访问
表3返回参数说明
参数名称参数说明值
code状态码200表示成功
msg返回信息的相关描述
data返回数据格式见表4
表4data参数示例说明
参数名称参数说明备注
Id用户Id
email用户邮箱
name账号
mobile手机号
orgId机构Id
orgName机构名称
roleIds角色Id集合
roleNames角色名称
status用户状态
sex性别0:男;1:女
remove是否被移除0:未被移除;1:已被移除
sysNames系统名称集合
7.1.2验证账号密码
请求URL:/user/verifyUsernameAndPassword。
请求方式:POST。
调用量上限(次/日):500。
请求参数见表5,接口返回参数见表6,data参数示例见表7。
表5验证账号密码请求参数说明
名称说明必传类型备注
username账号是String
password密码是String
roleids标识是String
3
DB15/T3486.4—2024
表6返回参数说明
参数名称参数说明值
code状态码200表示成功
msg返回信息的相关描述
data返回数据格式见表7
表7data参数示例说明
参数名称参数说明备注
Id用户Id
email用户邮箱
name账号
mobile手机号
orgId机构Id
orgName机构名称
roleIds角色Id集合
roleNames角色名称
status用户状态
sex性别0:男;1:女
remove是否被移除0:未被移除;1:已被移除
sysNames系统名称集合
机构管理
7.2.1列表查询
请求url:/org/getOrgList。
请求方式:POST请求。
调用量上限(次/日):500。
请求头header见表8,请求参数见表9,返回参数说明见表10,data参数示例见表11。
表8列表查询请求头说明
参数名称参数说明值
X-Access-TokenToken557ff54d84aac8049d5309e155fc
表9列表查询请求参数说明
名称说明必传类型备注
alias机构简称否String
name机构名称否String
parentName上级机构名称否String
pageNum起始页是String
pageSize每页条数是String
表10查询列表返回参数说明
参数名称参数说明值
code状态码200
msg返回信息描述
data返回数据格式见表11
4
DB15/T3486.4—2024
表11data参数示例说明
参数名称参数说明备注
endrow结束行
hasNextPage是否有下一页false:无;ture:有
hasPrevious是否有历史数据false:无;ture:有
isFistPage是否是第一页false:不是;ture:是
isLastPage是否是最后一页false:不是;ture:是
list列表数据
navigatefirstPage导航至第一页
navigateLastPage导航至最后一页
navigatefirstPageNums导航至第一页页码
nextPage下一页
PageNum起始页
PageSize每页条数
prePage前一页
size大小
starRow开始行
total总数
7.2.2增加操作
请求url:/org/addOrg。
请求方式:POST请求。
调用量上限(次/日):500。
请求头header见表8,请求参数见表12,返回参数见表13。
表12增加操作请求参数情况
名称说明必传类型备注
alias机构简称是String
name机构名称是String
parentName上级机构名称是String
mdmCode机构编码否String
pid父id否String
sysCode
推荐标准
- DB44/T 1284-2014 公路收费自动车型分类系统 2014-01-28
- DB50/T 573.8-2014 桑蚕种 第8部分:桑蚕种催青技术规程 2014-11-21
- DB44/T 1290-2014 木塑围栏安装技术规范 2014-01-28
- DB50/T 573.4-2014 桑蚕种 第4部分:桑蚕种繁育技术规程 2014-11-21
- DB44/T 1288-2014 户外木塑地板铺装技术规范 2014-01-28
- DB50/T 573.6-2014 桑蚕种 第6部分:桑蚕种浸酸技术规程 2014-11-21
- DB50/T 573.3-2014 桑蚕种 第3部分 桑蚕种母蛾检疫规程 2014-11-21
- DB44/T 1287-2014 热转移用双向拉伸聚酯薄膜 2014-01-28
- DB50/T 573.5-2014 桑蚕种 第5部分:桑蚕种冷藏技术规程 2014-11-21
- DB50/T 573.7-2014 桑蚕种 第7部分:桑蚕种保护技术规程 2014-11-21