版權說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權,請進行舉報或認領
文檔簡介
ICS35.080
CCSL78
15
內(nèi)蒙古自治區(qū)地方標準
DB15/T3486.4—2024
內(nèi)蒙古北斗高分綜合應用服務平臺
第4部分:數(shù)據(jù)接口
InnermongoliaBeidouGaofencomprehensiveapplicationservice
platformPart4:Datainterface
2024-06-14發(fā)布2024-07-14實施
內(nèi)蒙古自治區(qū)市場監(jiān)督管理局發(fā)布
DB15/T3486.4—2024
目次
前言II
引言III
1范圍1
2規(guī)范性引用文件1
3術語和定義1
4縮略語1
5數(shù)據(jù)接口1
Web訪問接口1
數(shù)據(jù)推送接口2
6數(shù)據(jù)接口開發(fā)要求2
調(diào)用方式2
請求報文舉例2
響應報文舉例2
調(diào)用權限控制2
7接口說明3
用戶信息對接接口3
機構管理4
終端操作7
終端位置信息管理12
I
DB15/T3486.4—2024
前言
本文件按照GB/T1.1—2020《標準化工作導則第1部分:標準化文件的結構和起草規(guī)則》的規(guī)定
起草。
本文件是DB15/T3486《內(nèi)蒙古北斗高分綜合應用服務平臺》的第4部分。DB15/T3486已經(jīng)發(fā)布了
以下部分:
——第1部分:功能描述
——第2部分:短報文數(shù)據(jù)傳輸協(xié)議;
——第3部分:4G數(shù)據(jù)傳輸協(xié)議;
——第4部分:數(shù)據(jù)接口;
——第5部分:高分服務二次開發(fā)要求;
——第6部分:安全要求。
本文件由中共內(nèi)蒙古自治區(qū)委員會軍民融合發(fā)展委員會辦公室提出。
本文件由內(nèi)蒙古自治區(qū)軍民融合標準化技術委員會(SAM/TC57)歸口。
本文件起草單位:內(nèi)蒙古自治區(qū)軍民融合發(fā)展研究中心、航天恒星科技有限公司、內(nèi)蒙古衛(wèi)星應用
產(chǎn)業(yè)協(xié)會、內(nèi)蒙古自治區(qū)知識產(chǎn)權保護中心、內(nèi)蒙古自治區(qū)大數(shù)據(jù)中心。
本文件主要起草人:王偉、孟斌、劉賀、吳凱、崔濤、蘇明明、郭稚鷹、王雯鐸、任淑慧、郭嘉麗、
李申陽、史欣赫、史凌峰、董國棟、袁鵬、張靜、張建軍、石彥龍。
II
DB15/T3486.4—2024
引言
制定北斗高分綜合應用服務平臺功能描述、數(shù)據(jù)傳輸協(xié)議、數(shù)據(jù)接口、二次開發(fā)和安全要求系列標
準有助于構建一個功能豐富、安全可信、易于集成和拓展的北斗高分綜合應用服務平臺,推動相關產(chǎn)業(yè)
的快速發(fā)展,提高用戶體驗,促進創(chuàng)新。北斗高分綜合應用服務平臺系列標準由六部分構成。
——第1部分:功能描述。有助于確保不同組件和模塊之間的功能一致性,避免因不同開發(fā)者理
解不同而導致的功能差異。明確的功能描述可以提高開發(fā)人員的理解和實現(xiàn)的一致性。有助
于提供一致的用戶體驗。無論用戶使用平臺的哪一部分,他們都能夠期望相似的功能和操作
方式,降低了學習成本和提高了用戶滿意度。
——第2部分:短報文數(shù)據(jù)傳輸協(xié)議。制定短報文數(shù)據(jù)傳輸協(xié)議標準確保不同組件和模塊之間能
夠進行有效的數(shù)據(jù)交換,提高了平臺的互操作性。這對于整合不同數(shù)據(jù)源、設備和服務至關
重要。
——第3部分:4G數(shù)據(jù)傳輸協(xié)議。優(yōu)化的數(shù)據(jù)傳輸協(xié)議可以提高數(shù)據(jù)傳輸效率,減少網(wǎng)絡帶寬的
占用,加速數(shù)據(jù)處理和分析的過程。
——第4部分:數(shù)據(jù)接口。定義統(tǒng)一的數(shù)據(jù)接口標準有助于不同組件和系統(tǒng)之間實現(xiàn)更加順暢的
數(shù)據(jù)交互,提高平臺的互操作性,支持各類數(shù)據(jù)的集成與共享。
——第5部分:高分服務二次開發(fā)要求。制定二次開發(fā)標準有助于構建健康的開發(fā)生態(tài)系統(tǒng)。標
準化的開發(fā)接口和工具使得第三方開發(fā)者更容易參與平臺的生態(tài)系統(tǒng),從而促進創(chuàng)新和市場
競爭。明確的二次開發(fā)標準降低了開發(fā)者的學習成本,加速了應用程序和服務的開發(fā)周期。
——第6部分:安全要求。制定安全要求標準有助于確保平臺對于數(shù)據(jù)和用戶隱私的處理是安全
可靠的。這對于用戶信任的建立至關重要,也有助于維護平臺的聲譽。
III
DB15/T3486.4—2024
內(nèi)蒙古北斗高分綜合應用服務平臺
第4部分:數(shù)據(jù)接口
1范圍
本文件規(guī)定了內(nèi)蒙古北斗高分綜合應用服務平臺不同功能模塊間的數(shù)據(jù)接口、數(shù)據(jù)接口開發(fā)要求
及接口說明。
本文件適用于內(nèi)蒙古北斗高分綜合應用服務平臺(以下簡稱平臺)的接口設計。
2規(guī)范性引用文件
下列文件中的內(nèi)容通過文中的規(guī)范性引用而構成本文件必不可少的條款。其中,注日期的引用文件,
僅該日期對應的版本適用于本文件;不注日期的引用文件,其最新版本(包括所有的修改單)適用于本
文件。
GB/T11457信息技術軟件工程術語
GB/T25070信息安全技術網(wǎng)絡安全等級保護安全設計技術要求
3術語和定義
GB/T11457、GB/T25070界定的以及下列術語和定義適用于本文件。
數(shù)據(jù)接口datainterface
提供異構數(shù)據(jù)源統(tǒng)一標準化的數(shù)據(jù)對外應用開發(fā)接口服務,滿足個性化數(shù)據(jù)需求。
注:數(shù)據(jù)接口分為WEB訪問接口、數(shù)據(jù)推送接口。
4縮略語
下列縮略語適用于本文件。
ID:身份標識號縮寫,具有唯一性(Identitydocument)
IMEI:國際移動設備識別碼,即設備序列號,具有唯一性(Internationalmobileequipment
identity)
5數(shù)據(jù)接口
Web訪問接口
Web訪問接口為業(yè)務系統(tǒng)中的數(shù)據(jù)需求提供數(shù)據(jù)服務支持。通過標準協(xié)議和個性化參數(shù)來滿足各業(yè)
務系統(tǒng)的數(shù)據(jù)需求。整個WEB訪問接口基于大數(shù)據(jù)基礎支撐組件并采用分布式架構,提供跨編程語言、
1
DB15/T3486.4—2024
跨操作系統(tǒng)平臺的遠程調(diào)用,向外界提供一系列能通過Web調(diào)用的API接口實現(xiàn)其他業(yè)務應用調(diào)用,滿足
內(nèi)蒙古北斗高分行業(yè)其他業(yè)務需求。
數(shù)據(jù)推送接口
通過利用消息隊列構建業(yè)務數(shù)據(jù)推送接口服務,同時針對不同的場景可用采用不同的推送模式,滿
足個性化推送需求。為了提升推送的到達率,可通過服務發(fā)起多種類型的消息推送,用戶可根據(jù)實際的
業(yè)務場景,選擇合適的推送內(nèi)容、推送渠道以及推送方式。
6數(shù)據(jù)接口開發(fā)要求
調(diào)用方式
支持如下HTTP調(diào)用方式:
a)PUT:更新資源,請求消息必須包含資源中的部分或所有成員;
b)POST:創(chuàng)建資源,請求消息必須包含資源中的一個成員;
c)GET:請求指定的資源信息;
d)DELETE:刪除一個或所有支持post方法的資源成員。
請求報文舉例
當方法是PUT/POST時,HTTP主體通常需要包含JSON數(shù)據(jù)。請求必須發(fā)送到服務端的HTTP/HTTPS端口。
響應報文舉例
響應報文舉例如下:
a)“URL”:代表HTTP請求消息攜帶的URL。求方法為get/put/delete時,URL與請求中的URL
相同。post請求,它是新創(chuàng)建對象的URL。客戶端可以使用它直接獲取新對象;
b)“CreatedID”:代表資源支持httppost/delete方法。它將傳輸新對象的ID,該ID由服務
器為新對象創(chuàng)建;
c)“Code”:代表處理系統(tǒng)結果,表1常見狀態(tài)碼說明;
d)“msg”:代表處理系統(tǒng)結果的解釋;
e)“Data”:請求(獲取)的資源的信息或數(shù)據(jù)。大多數(shù)情況下都是JSON。對于相同的URL,放
置請求數(shù)據(jù)格式與getresponse中的數(shù)據(jù)相同。如果服務器工作失敗,或者HTTP方法為
Put/Post,則響應“data"包含”null"。
表1常見狀態(tài)碼說明
狀態(tài)碼狀態(tài)碼說明備注
200訪問服務器成功
404請求訪問的資源在服務器上不存在
403訪問被拒絕,當前主機沒有權限
405訪問的服務器不支持當前請求所用的方法
500訪問的服務器出現(xiàn)內(nèi)部錯誤
504訪問的服務器負載比較大,可能會導致出現(xiàn)超時的情況
302訪問的服務器臨時重定向,臨時需要跳轉(zhuǎn)到其他頁面
301訪問的服務器永久重定向,永久性的跳轉(zhuǎn)到其他頁面
調(diào)用權限控制
2
DB15/T3486.4—2024
調(diào)用接口前需獲取Token,并在請求頭參數(shù)中包含“X-Access-Token”參數(shù),否則調(diào)用失敗。
7接口說明
用戶信息對接接口
7.1.1獲取用戶信息
請求url:/user/getUserInfoByToken。
請求方式:POST。
調(diào)用量上限(次/日):500。
請求頭參數(shù)見表2,接口返回參數(shù)見表3,data參數(shù)示例見表4。
表2獲取用戶信息請求頭參數(shù)
參數(shù)名稱參數(shù)說明備注
X-Access-Tokentoken
app請求頭中是否有app;有,則是app端訪問否則是web端訪問
表3返回參數(shù)說明
參數(shù)名稱參數(shù)說明值
code狀態(tài)碼200表示成功
msg返回信息的相關描述
data返回數(shù)據(jù)格式見表4
表4data參數(shù)示例說明
參數(shù)名稱參數(shù)說明備注
Id用戶Id
email用戶郵箱
name賬號
mobile手機號
orgId機構Id
orgName機構名稱
roleIds角色Id集合
roleNames角色名稱
status用戶狀態(tài)
sex性別0:男;1:女
remove是否被移除0:未被移除;1:已被移除
sysNames系統(tǒng)名稱集合
7.1.2驗證賬號密碼
請求URL:/user/verifyUsernameAndPassword。
請求方式:POST。
調(diào)用量上限(次/日):500。
請求參數(shù)見表5,接口返回參數(shù)見表6,data參數(shù)示例見表7。
表5驗證賬號密碼請求參數(shù)說明
名稱說明必傳類型備注
username賬號是String
password密碼是String
roleids標識是String
3
DB15/T3486.4—2024
表6返回參數(shù)說明
參數(shù)名稱參數(shù)說明值
code狀態(tài)碼200表示成功
msg返回信息的相關描述
data返回數(shù)據(jù)格式見表7
表7data參數(shù)示例說明
參數(shù)名稱參數(shù)說明備注
Id用戶Id
email用戶郵箱
name賬號
mobile手機號
orgId機構Id
orgName機構名稱
roleIds角色Id集合
roleNames角色名稱
status用戶狀態(tài)
sex性別0:男;1:女
remove是否被移除0:未被移除;1:已被移除
sysNames系統(tǒng)名稱集合
機構管理
7.2.1列表查詢
請求url:/org/getOrgList。
請求方式:POST請求。
調(diào)用量上限(次/日):500。
請求頭header見表8,請求參數(shù)見表9,返回參數(shù)說明見表10,data參數(shù)示例見表11。
表8列表查詢請求頭說明
參數(shù)名稱參數(shù)說明值
X-Access-TokenToken557ff54d84aac8049d5309e155fc
表9列表查詢請求參數(shù)說明
名稱說明必傳類型備注
alias機構簡稱否String
name機構名稱否String
parentName上級機構名稱否String
pageNum起始頁是String
pageSize每頁條數(shù)是String
表10查詢列表返回參數(shù)說明
參數(shù)名稱參數(shù)說明值
code狀態(tài)碼200
msg返回信息描述
data返回數(shù)據(jù)格式見表11
4
DB15/T3486.4—2024
表11data參數(shù)示例說明
參數(shù)名稱參數(shù)說明備注
endrow結束行
hasNextPage是否有下一頁false:無;ture:有
hasPrevious是否有歷史數(shù)據(jù)false:無;ture:有
isFistPage是否是第一頁false:不是;ture:是
isLastPage是否是最后一頁false:不是;ture:是
list列表數(shù)據(jù)
navigatefirstPage導航至第一頁
navigateLastPage導航至最后一頁
navigatefirstPageNums導航至第一頁頁碼
nextPage下一頁
PageNum起始頁
PageSize每頁條數(shù)
prePage前一頁
size大小
starRow開始行
total總數(shù)
7.2.2增加操作
請求url:/org/addOrg。
請求方式:POST請求。
調(diào)用量上限(次/日):500。
請求頭header見表8,請求參數(shù)見表12,返回參數(shù)見表13。
表12增加操作請求參數(shù)情況
名稱說明必傳類型備注
alias機構簡稱是String
name機構名稱是String
parentName上級機構名稱是String
mdmCode機構編碼否String
pid父id否String
sysCode系統(tǒng)code否String
userId用戶id’否String
表13增加操作返回參數(shù)說明
參數(shù)名稱參數(shù)說明值
code狀態(tài)碼200
msg返回信息描述
data返回數(shù)據(jù)
7.2.3修改操作
請求url:/org/updateOrg。
請求方式:POST請求。
調(diào)用量上限(次/日):500。
請求頭header見表8,請求參數(shù)見表14,返回參數(shù)見表15。
5
DB15/T3486.4—2024
表14修改操作請求參數(shù)情況
名稱說明必傳類型備注
alias機構簡稱是String
createBy創(chuàng)建人否String
id數(shù)據(jù)Id是String
level等級否String
name機構名稱是String
orgType機構類型是String
parentName上級機構名稱是String
pid父id否String
remark備注否String
remove是否移除是String
sysCode系統(tǒng)code否String
sysName系統(tǒng)名稱否String
updateBy更新人否String
userId用戶id否String
表15修改操作返回參數(shù)說明
參數(shù)名稱參數(shù)說明值
code狀態(tài)碼200
data返回數(shù)據(jù)
msg返回信息描述
7.2.4刪除操作
請求url:/org/deleteOrg。
請求方式:POST請求。
調(diào)用量上限(次/日):500。
請求頭header見表8,請求參數(shù)見表16,返回參數(shù)見表17。
表16刪除操作請求參數(shù)情況
名稱說明必傳類型備注
id刪除數(shù)據(jù)的id是String
userId用戶id是String
表17刪除操作返回參數(shù)說明
參數(shù)名稱參數(shù)說明值
code狀態(tài)碼200
data返回數(shù)據(jù)
msg返回信息描述
7.2.5獲取所有機構樹形結構
6
DB15/T3486.4—2024
請求url:/org/getAllOrgTree。
請求方式:POST請求。
調(diào)用量上限(次/日):1000。
請求參數(shù):無,返回參數(shù)見表18,data參數(shù)示例見表19。
表18獲取所有機構樹形結構返回參數(shù)說明
參數(shù)名稱參數(shù)說明值
code狀態(tài)碼200
msg返回信息描述
data返回數(shù)據(jù)格式見表19
表19data參數(shù)示例說明
參數(shù)名稱參數(shù)說明備注
id機構Id
name機構名稱
pid父Id
Id:子節(jié)點Id;
children子節(jié)點name:子節(jié)點名稱;
pid:所屬父節(jié)點Id
終端操作
7.3.1列表查詢
請求url:/terminal/listTerminalTies。
請求方式:POST請求。
調(diào)用量上限(次/日):1000。
請求頭header見表8,請求參數(shù)見表20,返回參數(shù)見表21,data參數(shù)示例見表22,返回列表參
數(shù)說明見表23。
表20列表查詢請求參數(shù)情況
名稱說明必傳類型備注
objType工作狀態(tài)否String
orgId機構id否String
terminalModel終端型號否String
智慧巡邊-102001
森林防火-102002
sysCode所屬系統(tǒng)code否String
智慧放牧-102003
農(nóng)牧機械-102004
terminalType終端類型否String
7
DB15/T3486.4—2024
表20列表查詢請求參數(shù)情況(續(xù))
名稱說明必傳類型備注
simNosSim卡號否String
beidouNos北斗編號否String
terminalNo終端序列號否String
tieFlag是否綁卡否String
pageNum起始頁是String
pageSize每頁條數(shù)是String
表21終端列表返回參數(shù)說明
參數(shù)名稱參數(shù)說明值
code狀態(tài)碼200
msg返回信息描述
data返回數(shù)據(jù)格式見表22
表22終端列表data參數(shù)示例說明
參數(shù)名稱參數(shù)說明備注
endrow結束行
hasNextPage是否有下一頁false:無;true:有
hasPrevious是否有歷史數(shù)據(jù)false:無;true:有
isFistPage是否是第一頁false:不是;true:是
isLastPage是否是最后一頁false:不是;true:是
list列表數(shù)據(jù)格式見表23
navigatefirstPage導航至第一頁
navigateLastPage導航至最后一頁
navigatefirstPageNums導航至第一頁頁碼
nextPage下一頁
PageNum起始頁
PageSize每頁條數(shù)
prePage前一頁
size大小
starRow開始行
total總數(shù)
8
DB15/T3486.4—2024
表23返回列表參數(shù)說明
參數(shù)名稱參數(shù)說明備注
beidouId北斗卡編號
beidouIds多個北斗卡編號用逗號隔開
beidouList北斗實體
beidouNos北斗卡
createBy創(chuàng)建人
createTime創(chuàng)建時間
dataProtocol:數(shù)據(jù)協(xié)議
delFlag刪除狀態(tài)0:未刪除;1:刪除
id終端信息表主鍵id
imei終端imei號
manufactured生產(chǎn)廠家
modelId:終端類型編號
msgFlag是否支持短報文通信1:是;0:否
orgId所屬機構id
orgName所屬機構名字
remark備注
simIdsim卡編號
simIds多個sim卡編號逗號隔開
simList多個sim卡號
simNossim卡號
sn終端SN號
sysCode所屬系統(tǒng)code
sysname所屬系統(tǒng)名稱
terminalActivetime激活時間
terminalAuthcode終端鑒權碼
terminalFirmwareVersion固件版本
terminalModel終端型號
terminalName終端名
terminalNo終端序列號
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
- 4. 未經(jīng)權益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
- 6. 下載文件中如有侵權或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 跨境電商獨立站服務器安裝協(xié)議2025
- 初級應急救護考試試題及答案
- 2025-2026人教版小學三年級音樂上學期期末測試卷
- 融資融券開戶試題及答案
- 2025-2026人教版二年級語文期末測試卷
- 2025-2026七年級上學期道德與法治測試
- 面包店衛(wèi)生系統(tǒng)管理制度
- 小學衛(wèi)生院規(guī)章制度
- 某機關衛(wèi)生管理制度
- 環(huán)境衛(wèi)生管理制度及流程
- 《筑牢安全防線 歡度平安寒假》2026年寒假安全教育主題班會課件
- 2026國家國防科技工業(yè)局所屬事業(yè)單位第一批招聘62人備考題庫及答案詳解(新)
- 信息技術應用創(chuàng)新軟件適配測評技術規(guī)范
- 2026版安全隱患排查治理
- 道路施工安全管理課件
- 肉瘤的課件教學課件
- VTE患者并發(fā)癥預防與處理
- 車輛救援合同協(xié)議書
- 貴州省遵義市匯川區(qū)2024-2025學年八年級上學期12月期末數(shù)學試題
- UWB定位是什么協(xié)議書
- 第三終端藥品銷售技巧
評論
0/150
提交評論