DB15-T 3486.4-2024 内蒙古北斗高分综合应用服务平台 第4部分：数据接口

ICS35.08015IDB15/T3486.4—2024前言 12规范性引用文件 13术语和定义 14缩略语 15数据接口 1 15.2数据推送接口 26数据接口开发要求 2 26.2请求报文举例 2 26.4调用权限控制 27接口说明 37.1用户信息对接接口 37.2机构管理 4 77.4终端位置信息管理 DB15/T3486.4—2024本文件按照GB/T1.1—2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定起草。本文件是DB15/T3486《内蒙古北斗高分综合应用服务平台》的第4部分。DB15/T3486已经发布了——第1部分：功能描述——第2部分：短报文数据传输协议；——第3部分：4G数据传输协议；——第4部分：数据接口；——第5部分：高分服务二次开发要求；——第6部分：安全要求。本文件由中共内蒙古自治区委员会军民融合发展委员会办公室提出。本文件由内蒙古自治区军民融合标准化技术委员会（SAM/TC57）归口。本文件起草单位：内蒙古自治区军民融合发展研究中心、航天恒星科技有限公司、内蒙古卫星应用产业协会、内蒙古自治区知识产权保护中心、内蒙古自治区大数据中心。本文件主要起草人：王伟、孟斌、刘贺、吴凯、崔涛、苏明明、郭稚鹰、王雯铎、任淑慧、郭嘉丽、李申阳、史欣赫、史凌峰、董国栋、袁鹏、张静、张建军、石彦龙。DB15/T3486.4—2024制定北斗高分综合应用服务平台功能描述、数据传输协议、数据接口、二次开发和安全要求系列标准有助于构建一个功能丰富、安全可信、易于集成和拓展的北斗高分综合应用服务平台，推动相关产业的快速发展，提高用户体验，促进创新。北斗高分综合应用服务平台系列标准由六部分构成。——第1部分：功能描述。有助于确保不同组件和模块之间的功能一致性，避免因不同开发者理解不同而导致的功能差异。明确的功能描述可以提高开发人员的理解和实现的一致性。有助于提供一致的用户体验。无论用户使用平台的哪一部分，他们都能够期望相似的功能和操作方式，降低了学习成本和提高了用户满意度。——第2部分：短报文数据传输协议。制定短报文数据传输协议标准确保不同组件和模块之间能够进行有效的数据交换，提高了平台的互操作性。这对于整合不同数据源、设备和服务至关重要。——第3部分：4G数据传输协议。优化的数据传输协议可以提高数据传输效率，减少网络带宽的占用，加速数据处理和分析的过程。——第4部分：数据接口。定义统一的数据接口标准有助于不同组件和系统之间实现更加顺畅的数据交互，提高平台的互操作性，支持各类数据的集成与共享。——第5部分：高分服务二次开发要求。制定二次开发标准有助于构建健康的开发生态系统。标准化的开发接口和工具使得第三方开发者更容易参与平台的生态系统，从而促进创新和市场竞争。明确的二次开发标准降低了开发者的学习成本，加速了应用程序和服务的开发周期。——第6部分：安全要求。制定安全要求标准有助于确保平台对于数据和用户隐私的处理是安全可靠的。这对于用户信任的建立至关重要，也有助于维护平台的声誉。DB15/T3486.4—20241内蒙古北斗高分综合应用服务平台第4部分：数据接口本文件规定了内蒙古北斗高分综合应用服务平台不同功能模块间的数据接口、数据接口开发要求及接口说明。本文件适用于内蒙古北斗高分综合应用服务平台（以下简称平台）的接口设计。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T11457信息技术软件工程术语GB/T25070信息安全技术网络安全等级保护安全设计技术要求3术语和定义GB/T11457、GB/T25070界定的以及下列术语和定义适用于本文件。3.1数据接口datainterface提供异构数据源统一标准化的数据对外应用开发接口服务，满足个性化数据需求。4缩略语下列缩略语适用于本文件。ID：身份标识号缩写，具有唯一性（Identitydocument）IMEI：国际移动设备识别码,即设备序列号，具有唯一性（Internationalmobileequipmentidentity）5数据接口5.1Web访问接口Web访问接口为业务系统中的数据需求提供数据服务支持。通过标准协议和个性化参数来满足各业务系统的数据需求。整个WEB访问接口基于大数据基础支撑组件并采用分布式架构，提供跨编程语言、2DB15/T3486.4—2024跨操作系统平台的远程调用，向外界提供一系列能通过Web调用的API接口实现其他业务应用调用，满足内蒙古北斗高分行业其他业务需求。5.2数据推送接口通过利用消息队列构建业务数据推送接口服务，同时针对不同的场景可用采用不同的推送模式，满足个性化推送需求。为了提升推送的到达率，可通过服务发起多种类型的消息推送，用户可根据实际的业务场景，选择合适的推送内容、推送渠道以及推送方式。6数据接口开发要求支持如下HTTP调用方式：a)PUT：更新资源，请求消息必须包含资源中的部分或所有成员；b)POST：创建资源，请求消息必须包含资源中的一个成员；c)GET：请求指定的资源信息；d)DELETE：删除一个或所有支持post方法的资源成员。6.2请求报文举例当方法是PUT/POST时，HTTP主体通常需要包含JSON数据。请求必须发送到服务端的HTTP/HTTPS端口。6.3响应报文举例响应报文举例如下：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常见状态码说明6.4调用权限控制DB15/T3486.4—20243调用接口前需获取Token，并在请求头参数中包含“X-Access-Token”参数，否则调用失败。7接口说明7.1用户信息对接接口7.1.1获取用户信息请求url：/user/getUserInfoByToken。请求方式：POST。调用量上限（次/日）：500。请求头参数见表2，接口返回参数见表3，data参数示例见表4。表2获取用户信息请求头参数表3返回参数说明值表4data参数示例说明7.1.2验证账号密码请求URL：/user/verifyUsernameAndPassword。请求方式：POST。调用量上限（次/日）：500。请求参数见表5，接口返回参数见表6，data参数示例见表7。表5验证账号密码请求参数说明是是是DB15/T3486.4—20244表6返回参数说明值表7data参数示例说明7.2机构管理7.2.1列表查询请求url：/org/getOrgList。请求方式：POST请求。调用量上限（次/日）：500。请求头header见表8，请求参数见表9，返回参数说明见表10,data参数示例见表11。表8列表查询请求头说明值表9列表查询请求参数说明否否否是是表10查询列表返回参数说明值DB15/T3486.4—20245表11data参数示例说明7.2.2增加操作请求url：/org/addOrg。请求方式：POST请求。调用量上限（次/日）：500。请求头header见表8，请求参数见表12，返回参数见表13。表12增加操作请求参数情况是是是否否否用户id’否表13增加操作返回参数说明值7.2.3修改操作请求url：/org/updateOrg。请求方式：POST请求。调用量上限（次/日）：500。请求头header见表8，请求参数见表14，返回参数见表15。DB15/T3486.4—20246表14修改操作请求参数情况是否是否是是是否否是否否否否表15修改操作返回参数说明值7.2.4删除操作请求url：/org/deleteOrg。请求方式：POST请求。调用量上限（次/日）：500。请求头header见表8，请求参数见表16，返回参数见表17。表16删除操作请求参数情况是是表17删除操作返回参数说明值7.2.5获取所有机构树形结构DB15/T3486.4—20247请求url：/org/getAllOrgTree。请求方式：POST请求。调用量上限（次/日1000。请求参数：无，返回参数见表18，data参数示例见表19。表18获取所有机构树形结构返回参数说明值表19data参数示例说明7.3终端操作7.3.1列表查询请求url：/terminal/listTerminalTies。请求方式：POST请求。调用量上限（次/日1000。请求头header见表8，请求参数见表20，返回参数见表21，data参数示例见表22，返回列表参数说明见表23。表20列表查询请求参数情况否否否否否DB15/T3486.4—20248表20列表查询请求参数情况（续）否否否否是是表21终端列表返回参数说明值表22终端列表data参数示例说明DB15/T3486.4—20249表23返回列表参数说明dataProtocol:modelId:DB15/T3486.4—2024表23返回列表参数说明（续）warehouseworkStatus7.3.2增加操作请求url：/terminal/insertTerminal。请求方式：POST请求。调用量上限（次/日）：500。请求头header见表8，请求参数见表24，返回参数见表25。表24增加操作请求参数说明是是否workStatus否warehouse否是是是是否否否否否否否否否否否否否表25终端新增返回参数说明值7.3.3修改操作请求url：/terminal/updateTerminal。DB15/T3486.4—2024请求方式：POST请求。调用量上限（次/日）：500。请求头header见表8，请求参数见表26，返回参数见表27。表26修改操作请求参数说明否否否否否否否否否否否否否否是否否否否否否否否否否否是否否否否是是否否否否DB15/T3486.4—2024表26修改操作请求参数说明（续）否否warehouse否workStatus否表27终端修改返回参数说明值7.3.4删除操作请求url：/terminal/updateTerminalDelFlag。请求方式：POST请求。调用量上限（次/日）：500。请求头header见表8，请求参数见表28，返回参数见表29。表28删除操作请求参数说明是表29终端删除操作返回参数说明值7,4终端位置信息管理7.4.1获取终端位置信息（实时轨迹）请求url：/search/getLocation。请求方式：GET请求。调用量上限（次/日10000。请求参数见表30，返回参数见表31，data参数示例见表32。表30获取终端位置信息请求参数说明是DB15/T3486.4—2024表31获取终端位置信息返回参数说明值表32获取终端位置信息data返回参数说明7.4.2获取终端位置信息（历史轨迹）请求url：/dataVisit/findHistoryAll。请求方式：POST请求。调用量上限（次/日1000。请求参数见表33，返回参数见表34，返回数据格式见表35。表33获取终端位置信息（历史轨迹）请求参数说明是是是表34获取终端位置信息（历史轨迹）返回参数说明值表35获取终端位置信息返回数据格式说明7.4.3短报文下发下发接口：/BDDA/rest/command/messageTxtNew。请求方式：POST。DB15/T3486.4—2024调用量上限（次/日1000。请求参数见表36，返回参数见表3