遠程智慧計量檢測平臺接口要求(征求意見稿)_第1頁
遠程智慧計量檢測平臺接口要求(征求意見稿)_第2頁
遠程智慧計量檢測平臺接口要求(征求意見稿)_第3頁
遠程智慧計量檢測平臺接口要求(征求意見稿)_第4頁
遠程智慧計量檢測平臺接口要求(征求意見稿)_第5頁
已閱讀5頁,還剩12頁未讀 繼續免費閱讀

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領

文檔簡介

ICS

CCS點擊此處添加CCS號

團體標準

T/ZSMXXXX—XXXX

遠程智慧計量檢測平臺接口要求

InterfaceRequirementsforRemoteIntelligentTesting-measuringPlatform

(征求意見稿)

在提交反饋意見時,請將您知道的相關專利連同支持性文件一并附上。

XXXX-XX-XX發布XXXX-XX-XX實施

浙江省計量與標準化學會發布

T/ZSMXXXX—XXXX

前言

本文件按照GB/T1.1—2020《標準化工作導則第1部分:標準化文件的結構和起草規則》的規定

起草。

本文件由浙江省計量與標準化學會提出。

本文件由浙江省計量與標準化學會歸口。

本文件負責起草單位:浙江省計量科學研究院。

本文件參加起草單位:湖南華美信息系統有限公司、浙江天際互感器股份有限公司、寧波三維電測

設備有限公司、浙江歐感機械制造有限公司、杭州愛華儀器有限公司。

本文件主要起草人:朱懷球、劉毛毛、沈才忠、林峰、丁晟、鄭榕年、廖靈文、梅國健、張志凱、

肖堯、康凱、俞治豐、韓文保、練曉玲、張靜。

II

T/ZSMXXXX—XXXX

引言

遠程智慧計量檢測是在嚴格保證檢測公正、質量要素全控的前提下,構建以物聯視訊、智能安防、

環境保障、數據安全為核心的高集成度、高智能化物聯控制系統,通過全過程自動檢測,實現與檢測相

關的門禁、視頻監控、環境監測、實驗設備等第三方軟硬件系統的無縫對接,解決第三方軟硬件系統差

異化大、操控程序不一致的問題。

2021年浙江省計量科學研究院為主起草的團體標準《遠程智控方艙計量實驗室的要求》(T/ZSM

0003-2021)規范了遠程智控方艙計量實驗室的建設、運行和管理。在此基礎上,本文件進一步提出了

遠程智慧計量檢測平臺的接口要求,旨在實現異構系統數據對接統一入口、統一規范,便于遠程檢測數

據追溯與管理,大幅度降低無縫對接工作量、增強檢測數據的權威性與公信力。可為遠程計量檢測在不

同計量專業領域落地提供參考標準,便于不同語言、不同架構等異構環境下相應系統的接入,有助于遠

程計量檢測服務的橫向延伸。

III

T/ZSMXXXX—XXXX

遠程智慧計量檢測平臺接口要求

1范圍

本文件規定了遠程檢測裝置、自動化檢測裝置與遠程智慧計量檢測平臺間信息互通的接口技術要求。

本文件適用于指導企業在實施技術信息集成過程中,定義不同軟件的接口或選購軟件時作為判斷其

可集成程度的參考。

2規范性引用文件

本文件沒有規范性引用文件。

3術語和定義

下列術語和定義適用于本文件。

3.1

遠程智慧計量檢測平臺InterfaceRequirementsforRemoteIntelligentTesting-measuring

Platform

集計量檢測過程控制、計量檢測實驗數據管理、計量檢測實驗室環境數據管理于一體的應用程序。

3.2

遠程檢測裝置remotetestingdevice

實現遠程檢測所需的軟、硬件設施的集合。

3.3

自動化檢測裝置auto-testingdevice

實現自動化檢測所需的軟、硬件設施的集合。

3.4

通信協議communicationprotocol

指通信雙方對數據傳送控制的一種約定。

3.5

應用軟件applicationsoftware

應用軟件是為滿足用戶不同領域、不同問題的應用需求而提供的應用程序的集合。

3.6

http協議hypertexttransferprotocol(HTTP)

超文本傳輸協議(HyperTextTransferProtocol,HTTP)是一個簡單的請求-響應協議,它通常

運行在TCP之上。它指定了客戶端可能發送給服務器什么樣的消息以及得到什么樣的響應。

3.7

webservice協議webservice(WS)

WebService是一個平臺獨立的,低耦合的,自包含的、基于可編程的web應用程序。

3.8

1

T/ZSMXXXX—XXXX

接口提供方interfaceprovider

為第三方軟件提供信息所需接口的一方(軟件)。

3.9

接口調用方interfacecaller

為獲取信息,需調用第三方軟件的一方(軟件)。

3.10

鍵值對key-valuepair(KVP)

計算系統和應用程序中一種基本的數據表示,可以根據一個鍵值獲得對應的一個值,鍵是存的值的

編號,值是存編號所對應的數據。

3.11

Web應用Webapplication

可以通過Web(瀏覽器)訪問的應用程序。

3.12

結構化數據structureddata

也稱作行數據,是由二維表結構來邏輯表達和實現的數據,主要通過關系型數據庫進行存儲和管理。

3.13

非結構化數據unstructureddata

不適于由數據庫二維表來表現的非結構化數據,包括所有格式的辦公文檔、XML、HTML、各類報表、

圖片和音頻、視頻信息等。

4總體要求

需接入遠程智慧計量檢測平臺的遠程檢測裝置、自動化檢測裝置,應嚴格遵循本標準各要素要求,

確保安全接入、規范接入。

5通信協議

5.1http協議

基于遠程檢測平臺是一個Web應用,建議應用軟件間通信首選http傳輸協議向接口調用方提供服務。

5.2webservice協議

考慮到部分應用軟件不便提供http協議,比如一些純C端的應用程序,可采用webservice協議向接

口調用方提供服務。

6接口要求

6.1接口地址規范

接口地址需按“ip/域名+端口+api+接口路徑”格式書寫,如

2:8080/api/testData/testInfo)。請求方式為get或post。

6.2接口請求頭規范

為了便于接口判斷及接口兼容性,接口請求頭要求是json格式。

2

T/ZSMXXXX—XXXX

6.3接口簽名規則

通過接口調用所需服務前,接口提供方需有簽名驗證機制,驗證機制需通過MD5加密。

6.4接口參數規范

接口參數要求統一為json格式,json格式中鍵的命名需要按照小駝峰命名,指明數據類型。具體按

表1的要求。

表1參數格式要求

參數中文名英文名數據類型是否必填

調用方idappKeySting例如(wuzheng)

時間戳timeStamplong時間戳

xxxloginIdString不可為空

6.5接口返回數據規范

接口返回數據要求統一為json格式,參照以下模板提供。

{

“code”:“200”,

“msg”:“操作成功”,

“timestamp”:“yyyy-MM-ddhh:mm:ss”,

“data”:{}

}

7數據要求

7.1結構化數據

7.1.1針對父子級關系數需明確關聯關系,如有特定的字段標識其父子關系或以明確的數據格式體現

其父子關系。

7.1.2結構化數據需以json格式(鍵值對)的字符串傳輸。

7.1.3編碼格式統一為utf-8。

7.2非結構化數據

7.2.1針對父子級關系數需明確關聯關系,如以明確的數據格式體現其父子關系。

7.2.2非結構化數據(不含圖片、視頻、文件數據)須以json格式字符串傳輸,上下級數據關系以數

據格式體現。

7.2.3編碼格式utf-8。

7.3圖片數據

7.3.1圖片格式應為常用圖片格式,如jpg、gif、bmp、png、jpeg。

7.3.2圖片大小不應超過5M。

7.4文件數據

7.4.1文件格式應為word、excel、pdf。

7.4.2文件大小不應超過100M。

7.5視頻數據

7.5.1視頻文件格式統一為mp4。

7.5.2文件大小不超過1000M。

7.5.3視頻時長不超過2小時。

8安全要求

3

T/ZSMXXXX—XXXX

8.1信息通訊安全

8.1.1安全評估

應保證接口的自身安全,通過接口實現技術上的安全控制,做到對安全事件的“可知、可控、可預

測”,是實現系統安全的一個重要基礎。

8.1.2訪問控制

需對軟硬件設備設施之間通信請求做一些限制,比如一分鐘內同一IP建議請求不超過60次。

8.1.3防惡意代碼

為防止惡意代碼攻擊應用軟件,應用軟件需采取以下措施:

a)應用軟件頁面或者功能必須進行權限控制校驗。

b)用戶輸入的SQL參數嚴格使用參數綁定或者METADATA字段值限定,防止SQL注入,禁止

字符串拼接SQL訪問數據庫。

c)禁止向HTML頁面輸出未經安全過濾或未正確轉義的用戶數據。

d)URL外部重定向傳入的目標地址須執行白名單過濾。

8.1.4加密

接口調用方及接口提供方應約定好統一的參數加密算法,要求如下:

a)對于賬號、密碼等非業務數據采用不可逆的MD5算法加密。

b)業務數據接口調用使用AEC算法加密,加密秘鑰可以規定包含某個時間范圍內的時間戳,如5

分鐘,1分鐘,30秒等,過期則失效。為確保各應用間的時間一致性,接口提供方和調用方

所對應的服務器時間應與北京時間同步。

8.2異常處理機制

應用軟件之間通信應具備異常處理機制,如表單驗證、唯一性檢查、或其他可預期的錯誤,應具備

異常處理機制相應接口,以便返回給接口調用方。

4

T/ZSMXXXX—XXXX

A

A

附錄A

(資料性)

平臺結構與接口示例

A.1平臺結構

平臺以SpringCloud作為微服務基礎設施,可以滿足不同的業務場景,WEB前端通過采用前沿的

響應式、高性能的輕量級Element+VUE組合框架提高系統的響應速度、界面美化、交互體驗,主體結構

如圖A.1。

圖A.1主體結構圖

Vue.js+ElementUI

(MVC)

ELK(日志監控)

原MinIO

始(對象存儲)

統作對

一象記

流RabbitMQ

權文錄(消息隊列)

引模

限擎件

服服Nacos

板配置注冊中心

服服()

務務務

務Sentinel

(熔斷限流)

MySQL(關系型)MongoDB(文檔型)Redis(內存型)

A.2結構化數據接口示例

A.2.1請求url地址:{url}/api/hm-collect-server/collectionApi/collection/record

A.2.2請求方式:POST

A.2.3請求參數示例:

{

"cer":"123456",

"uuid":"123456",

"joinId":"123456",

"parentJoinId":"123456",

"factoryNumber":"出廠編號",

"factory":"生產廠商名稱",

"customerName":"委托單位名稱",

"specification":"型號規格",

"objectParams":"[{"insParam":"標準砝碼編號","paramExplain":"結論"}]",

"paramData":"[{"檢定地點":"方艙實驗室","檢定結論":"合格"}]"

}

A.2.4joinId/parentJoinId參數示例:

5

T/ZSMXXXX—XXXX

a)一級數據:

{

"cer":"123456",

"uuid":"123456",

"joinId":"123456",

"parentJoinId":"",

"factoryNumber":"出廠編號",

"factory":"生產廠商名稱",

"customerName":"委托單位名稱",

"specification":"型號規格",

"objectParams":"[{"insParam":"標準砝碼編號","paramExplain":"結論"}]",

"paramData":"[{"檢定地點":"方艙實驗室","檢定結論":"合格"}]"

}

b)二級數據:

{

"cer":"123456",

"uuid":"123456",

"joinId":"",

"parentJoinId":"123456",(與父級數據的joinId相同),

"factoryNumber":"出廠編號",

"factory":"生產廠商名稱",

"customerName":"委托單位名稱",

"specification":"型號規格",

"objectParams":"[{"insParam":"標準砝碼編號","paramExplain":"結論"}]",

"paramData":"[{"檢定地點":"方艙實驗室","檢定結論":"合格"}]"

}

表A.1請求參數說明

參數名說明是否必須備注

cer權限驗證碼是用于校驗數據來源

uuid樣品唯一標識是用于校驗樣品

joinId子數據關聯標識多級數據時,做為父級標識

多級數據時,做為子級標識,

parentJoinId上級數據關聯標識

關聯joinId

factoryNumber樣品出廠編號

factory制造廠商

customerName委托單位

specification型號規格

objectParams對象參數說明String格式的json數據

paramData采集數據包String格式的json數據

注:對象參數說明/采集數據包,至少一個需要有值

A.2.5返回參數示例:

{

"status":200,

"message":"操作成功"

}

表A.2返回參數說明

參數名說明類型備注

只有200為成功,(其他部分狀

status狀態碼number

態碼說明400:請求參數異

6

T/ZSMXXXX—XXXX

參數名說明類型備注

常,500:接口內部服務異常

等)

message消息String對本次調用結果的中文說明

A.3非結構化數據接口示例

A.3.1請求url地址:{url}/api/hm-collect-server/collectionApi/collection/testInfo

A.3.2請求方式:POST

A.3.3請求參數示例:

{

"cer":"123456",

"uuid":"123456",

"joinId":"123456",

"parentJoinId":"123456",

"objectParams":"[{"insParam":"標準砝碼編號","paramExplain":"結論"}]",

"paramData":"[{"檢定地點":"方艙實驗室","檢定結論":"合格"}]"

}

A.3.4joinId/parentJoinId參數示例:

a)一級數據:

{

"cer":"123456",

"uuid":"123456",

"joinId":"123456",

"parentJoinId":"",

"objectParams":"[{"insParam":"標準砝碼編號","paramExplain":"結論"}]",

"paramData":"[{"檢定地點":"方艙實驗室","檢定結論":"合格"}]"

}

b)二級數據:

{

"cer":"123456",

"uuid":"123456",

"joinId":"",

"parentJoinId":"123456",(與父級數據的joinId相同),

"objectParams":"[{"insParam":"標準砝碼編號","paramExplain":"結論"}]",

"paramData":"[{"檢定地點":"方艙實驗室","檢定結論":"合格"}]"

}

表A.3請求參數解釋

參數名說明是否必須備注

cer權限驗證碼是用于校驗數據來源

uuid樣品唯一標識是用于校驗樣品

joinId子數據關聯標識多級數據時,做為父級標識

多級數據時,做為子級標識,

parentJoinId上級數據關聯標識

關聯joinId

objectParams對象參數說明String格式的json數據

paramData采集數據包String格式的json數據

注:對象參數說明/采集數據包,至少一個需要有值

A.3.5返回參數示例:

{

"status":200,

7

T/ZSMXXXX—XXXX

"message":"操作成功"

}

表A.4返回參數說明

參數名說明類型備注

只有200為成功,(其他部分狀

態碼說明400:請求參數異

status狀態碼number

常,500:接口內部服務異常

等)

message消息String對本次調用結果的中文說明

A.4文件傳輸接口示例

A.4.1請求url地址:{url}/api/hm-collect-server/collectionApi/collection/file

A.4.2請求方式:POST

A.4.3請求參數:

a)hearders:

表A.5請求參數說明

參數名參數值是否必須備注

Content-Typemultipart/form-data是

b)Body:

表A.6請求參數說明

參數名說明是否必須備注

cer權限驗證碼是用于校驗數據來源

uuid樣品唯一標識是用于校驗樣品

joinId子數據關聯標識多級數據時,做為父級標識

多級數據時,做為子級標識,

parentJoinId上級數據關聯標識

關聯joinId

factoryNumber樣品出廠編號

factory制造廠商

customerName委托單位

specification型號規格

collectTime采集時間yyyy-MM-sshh:mm:ss

需要上傳的文件,是一個file

file文件是

類型的文件

A.4.4返回參數示例:

{

"status":200,

"message":"操作成功"

}

表A.7返回參數說明

參數名說明類型備注

只有200為成功,(其他部分狀

態碼說明400:請求參數異

status狀態碼number

常,500:接口內部服務異常

等)

message消息String對本次調用結果的中文說明

A.5圖片傳輸接口示例

A.5.1請求url地址:{url}/api/hm-shelter/shelters/Collection/Monitoring

8

T/ZSMXXXX—XXXX

A.5.2請求方式:POST

A.5.3請求參數:

a)hearders:

表A.8請求參數說明

參數名參數值是否必須備注

Content-Typemultipart/form-data是

b)Body:

表A.9請求參數說明

參數名參數值是否必須備注

cer權限驗證碼是用于校驗數據來源

equipmentId監控設備標識是用于校驗監控設備

type數據類型是傳入值只能是:

“圖片”或者“視頻”

圖片/視頻附件。需要上傳的

file監控數據是

文件,是一個file類型的文件

yyyy-MM-sshh:mm:ss

collectionTime抓拍時間

圖片的采集時間

type為“圖片”時必傳

yyyy-MM-sshh:mm:ss

startTime視頻采集開始時間

視頻的開始采集時間

type為“視頻”時必傳

yyyy-MM-sshh:mm:ss

endTime視頻采集結束時間

視頻的結束采集時間

type為“視頻”時必傳

注:采集時間只需在type為圖片時傳入。

視頻采集開始/結束時間只需在type為視頻時傳入。

A.5.4返回參數示例:

{

"status":200,

"message":"操作成功"

}

表A.10返回參數說明

參數名說明類型備注

只有200為成功,(其他部分狀

態碼說明400:請求參數異

status狀態碼number

常,500:接口內部服務異常

等)

message消息String對本次調用結果的中文說明

A.6視頻數據接口示例

A.6.1請求url地址。{url}/api/hm-shelter/shelters/Collection/Monitoring

A.6.2請求方式:POST

A.6.3請求參數:

a)hearders:

9

T/ZSMXXXX—XXXX

表A.11請求參數解釋

參數名參數值是否必須備注

Content-Typemultipart/form-data是

b)Body:

表A.12請求參數解釋

參數名說明是否必須備注

cer權限驗證碼是用于校驗數據來源

equipmentId監控設備標識是用于校驗監控設備

type數據類型是傳入值只能是:

“圖片”或者“視頻”

圖片/視頻附件。需要上傳的

file監控數據是

文件,是一個file類型的文件

yyyy-MM-sshh:mm:ss

collectionTime抓拍時間

圖片的采集時間

type為“圖片”時必傳

yyyy-MM-sshh:mm:ss

startTime視頻采集開始時間

視頻的開始采集時間

type為“視頻”時必傳

yyyy-MM-sshh:mm:ss

endTime視頻采集結束時間

視頻的結束采集時間

type為“視頻”時必傳

注:采集時間只需在type為圖片時傳入。

視頻采集開始/結束時間只需在type為視頻時傳入。

A.6.4返回參數示例:

{

"status":200,

"message":"操作成功"

}

表A.13返回參數說明

參數名說明類型備注

只有200為成功,(其他部分狀

態碼說明400:請求參數異

status狀態碼number

常,500:接口內部服務異常

等)

message消息String對本次調用結果的中文說明

10

T/ZSMXXXX—XXXX

參考文獻

[1]GB/T32908-2016非結構化數據訪問接口規范

[2]GA/T1293應用軟件接口標準編寫技術要素

[3]YD/T3496-2019Web安全日志格式及共享接口規范

11

T/ZSMXXXX—XXXX

目次

前言.................................................................................II

引言................................................................................III

1范圍...............................................................................1

2規范性引用文件.....................................................................1

3術語和定義.........................................................................1

4總體要求...........................................................................2

5通信協議...........................................................................2

5.1http協議......................................................

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經權益所有人同意不得將文件中的內容挪作商業或盈利用途。
  • 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
  • 6. 下載文件中如有侵權或不適當內容,請與我們聯系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論