《遠(yuǎn)程智慧計(jì)量檢測(cè)平臺(tái)接口要求》

ICS

CCS點(diǎn)擊此處添加CCS號(hào)

團(tuán)體標(biāo)準(zhǔn)

T/ZSMXXXX—XXXX

遠(yuǎn)程智慧計(jì)量檢測(cè)平臺(tái)接口要求

InterfaceRequirementsforRemoteIntelligentTesting-measuringPlatform

（征求意見稿）

在提交反饋意見時(shí)，請(qǐng)將您知道的相關(guān)專利連同支持性文件一并附上。

XXXX-XX-XX發(fā)布XXXX-XX-XX實(shí)施

浙江省計(jì)量與標(biāo)準(zhǔn)化學(xué)會(huì)發(fā)布

T/ZSMXXXX—XXXX

遠(yuǎn)程智慧計(jì)量檢測(cè)平臺(tái)接口要求

1范圍

本文件規(guī)定了遠(yuǎn)程檢測(cè)裝置、自動(dòng)化檢測(cè)裝置與遠(yuǎn)程智慧計(jì)量檢測(cè)平臺(tái)間信息互通的接口技術(shù)要求。

本文件適用于指導(dǎo)企業(yè)在實(shí)施技術(shù)信息集成過程中，定義不同軟件的接口或選購(gòu)軟件時(shí)作為判斷其

可集成程度的參考。

2規(guī)范性引用文件

本文件沒有規(guī)范性引用文件。

3術(shù)語和定義

下列術(shù)語和定義適用于本文件。

3.1

遠(yuǎn)程智慧計(jì)量檢測(cè)平臺(tái)InterfaceRequirementsforRemoteIntelligentTesting-measuring

Platform

集計(jì)量檢測(cè)過程控制、計(jì)量檢測(cè)實(shí)驗(yàn)數(shù)據(jù)管理、計(jì)量檢測(cè)實(shí)驗(yàn)室環(huán)境數(shù)據(jù)管理于一體的應(yīng)用程序。

3.2

遠(yuǎn)程檢測(cè)裝置remotetestingdevice

實(shí)現(xiàn)遠(yuǎn)程檢測(cè)所需的軟、硬件設(shè)施的集合。

3.3

自動(dòng)化檢測(cè)裝置auto-testingdevice

實(shí)現(xiàn)自動(dòng)化檢測(cè)所需的軟、硬件設(shè)施的集合。

3.4

通信協(xié)議communicationprotocol

指通信雙方對(duì)數(shù)據(jù)傳送控制的一種約定。

3.5

應(yīng)用軟件applicationsoftware

應(yīng)用軟件是為滿足用戶不同領(lǐng)域、不同問題的應(yīng)用需求而提供的應(yīng)用程序的集合。

3.6

http協(xié)議hypertexttransferprotocol(HTTP)

超文本傳輸協(xié)議（HyperTextTransferProtocol，HTTP）是一個(gè)簡(jiǎn)單的請(qǐng)求-響應(yīng)協(xié)議，它通常

運(yùn)行在TCP之上。它指定了客戶端可能發(fā)送給服務(wù)器什么樣的消息以及得到什么樣的響應(yīng)。

3.7

webservice協(xié)議webservice(WS)

WebService是一個(gè)平臺(tái)獨(dú)立的，低耦合的，自包含的、基于可編程的web應(yīng)用程序。

3.8

1

T/ZSMXXXX—XXXX

接口提供方interfaceprovider

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

3.9

接口調(diào)用方interfacecaller

為獲取信息，需調(diào)用第三方軟件的一方（軟件）。

3.10

鍵值對(duì)key-valuepair(KVP)

計(jì)算系統(tǒng)和應(yīng)用程序中一種基本的數(shù)據(jù)表示，可以根據(jù)一個(gè)鍵值獲得對(duì)應(yīng)的一個(gè)值，鍵是存的值的

編號(hào)，值是存編號(hào)所對(duì)應(yīng)的數(shù)據(jù)。

3.11

Web應(yīng)用Webapplication

可以通過Web（瀏覽器）訪問的應(yīng)用程序。

3.12

結(jié)構(gòu)化數(shù)據(jù)structureddata

也稱作行數(shù)據(jù)，是由二維表結(jié)構(gòu)來邏輯表達(dá)和實(shí)現(xiàn)的數(shù)據(jù)，主要通過關(guān)系型數(shù)據(jù)庫進(jìn)行存儲(chǔ)和管理。

3.13

非結(jié)構(gòu)化數(shù)據(jù)unstructureddata

不適于由數(shù)據(jù)庫二維表來表現(xiàn)的非結(jié)構(gòu)化數(shù)據(jù)，包括所有格式的辦公文檔、XML、HTML、各類報(bào)表、

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

4總體要求

需接入遠(yuǎn)程智慧計(jì)量檢測(cè)平臺(tái)的遠(yuǎn)程檢測(cè)裝置、自動(dòng)化檢測(cè)裝置，應(yīng)嚴(yán)格遵循本標(biāo)準(zhǔn)各要素要求，

確保安全接入、規(guī)范接入。

5通信協(xié)議

5.1http協(xié)議

基于遠(yuǎn)程檢測(cè)平臺(tái)是一個(gè)Web應(yīng)用，建議應(yīng)用軟件間通信首選http傳輸協(xié)議向接口調(diào)用方提供服務(wù)。

5.2webservice協(xié)議

考慮到部分應(yīng)用軟件不便提供http協(xié)議，比如一些純C端的應(yīng)用程序，可采用webservice協(xié)議向接

口調(diào)用方提供服務(wù)。

6接口要求

6.1接口地址規(guī)范

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

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

6.2接口請(qǐng)求頭規(guī)范

為了便于接口判斷及接口兼容性，接口請(qǐng)求頭要求是json格式。

2

T/ZSMXXXX—XXXX

6.3接口簽名規(guī)則

通過接口調(diào)用所需服務(wù)前，接口提供方需有簽名驗(yàn)證機(jī)制，驗(yàn)證機(jī)制需通過MD5加密。

6.4接口參數(shù)規(guī)范

接口參數(shù)要求統(tǒng)一為json格式，json格式中鍵的命名需要按照小駝峰命名，指明數(shù)據(jù)類型。具體按

表1的要求。

表1參數(shù)格式要求

參數(shù)中文名英文名數(shù)據(jù)類型是否必填

調(diào)用方idappKeySting例如（wuzheng）

時(shí)間戳timeStamplong時(shí)間戳

xxxloginIdString不可為空

6.5接口返回?cái)?shù)據(jù)規(guī)范

接口返回?cái)?shù)據(jù)要求統(tǒng)一為json格式，參照以下模板提供。

{

“code”:“200”,

“msg”:“操作成功”,

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

“data”:{}

}

7數(shù)據(jù)要求

7.1結(jié)構(gòu)化數(shù)據(jù)

7.1.1針對(duì)父子級(jí)關(guān)系數(shù)需明確關(guān)聯(lián)關(guān)系，如有特定的字段標(biāo)識(shí)其父子關(guān)系或以明確的數(shù)據(jù)格式體現(xiàn)

其父子關(guān)系。

7.1.2結(jié)構(gòu)化數(shù)據(jù)需以json格式（鍵值對(duì)）的字符串傳輸。

7.1.3編碼格式統(tǒng)一為utf-8。

7.2非結(jié)構(gòu)化數(shù)據(jù)

7.2.1針對(duì)父子級(jí)關(guān)系數(shù)需明確關(guān)聯(lián)關(guān)系，如以明確的數(shù)據(jù)格式體現(xiàn)其父子關(guān)系。

7.2.2非結(jié)構(gòu)化數(shù)據(jù)（不含圖片、視頻、文件數(shù)據(jù)）須以json格式字符串傳輸，上下級(jí)數(shù)據(jù)關(guān)系以數(shù)

據(jù)格式體現(xiàn)。

7.2.3編碼格式utf-8。

7.3圖片數(shù)據(jù)

7.3.1圖片格式應(yīng)為常用圖片格式，如jpg、gif、bmp、png、jpeg。

7.3.2圖片大小不應(yīng)超過5M。

7.4文件數(shù)據(jù)

7.4.1文件格式應(yīng)為word、excel、pdf。

7.4.2文件大小不應(yīng)超過100M。

7.5視頻數(shù)據(jù)

7.5.1視頻文件格式統(tǒng)一為mp4。

7.5.2文件大小不超過1000M。

7.5.3視頻時(shí)長(zhǎng)不超過2小時(shí)。

8安全要求

3

T/ZSMXXXX—XXXX

8.1信息通訊安全

8.1.1安全評(píng)估

應(yīng)保證接口的自身安全，通過接口實(shí)現(xiàn)技術(shù)上的安全控制，做到對(duì)安全事件的“可知、可控、可預(yù)

測(cè)”，是實(shí)現(xiàn)系統(tǒng)安全的一個(gè)重要基礎(chǔ)。

8.1.2訪問控制

需對(duì)軟硬件設(shè)備設(shè)施之間通信請(qǐng)求做一些限制，比如一分鐘內(nèi)同一IP建議請(qǐng)求不超過60次。

8.1.3防惡意代碼

為防止惡意代碼攻擊應(yīng)用軟件，應(yīng)用軟件需采取以下措施：

a)應(yīng)用軟件頁面或者功能必須進(jìn)行權(quán)限控制校驗(yàn)。

b)用戶輸入的SQL參數(shù)嚴(yán)格使用參數(shù)綁定或者M(jìn)ETADATA字段值限定，防止SQL注入，禁止

字符串拼接SQL訪問數(shù)據(jù)庫。

c)禁止向HTML頁面輸出未經(jīng)安全過濾或未正確轉(zhuǎn)義的用戶數(shù)據(jù)。

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

8.1.4加密

接口調(diào)用方及接口提供方應(yīng)約定好統(tǒng)一的參數(shù)加密算法，要求如下：

a)對(duì)于賬號(hào)、密碼等非業(yè)務(wù)數(shù)據(jù)采用不可逆的MD5算法加密。

b)業(yè)務(wù)數(shù)據(jù)接口調(diào)用使用AEC算法加密，加密秘鑰可以規(guī)定包含某個(gè)時(shí)間范圍內(nèi)的時(shí)間戳,如5

分鐘，1分鐘，30秒等，過期則失效。為確保各應(yīng)用間的時(shí)間一致性，接口提供方和調(diào)用方

所對(duì)應(yīng)的服務(wù)器時(shí)間應(yīng)與北京時(shí)間同步。

8.2異常處理機(jī)制

應(yīng)用軟件之間通信應(yīng)具備異常處理機(jī)制，如表單驗(yàn)證、唯一性檢查、或其他可預(yù)期的錯(cuò)誤，應(yīng)具備

異常處理機(jī)制相應(yīng)接口，以便返回給接口調(diào)用方。

4

T/ZSMXXXX—XXXX

A

A

附錄A

（資料性）

平臺(tái)結(jié)構(gòu)與接口示例

A.1平臺(tái)結(jié)構(gòu)

平臺(tái)以SpringCloud作為微服務(wù)基礎(chǔ)設(shè)施，可以滿足不同的業(yè)務(wù)場(chǎng)景，WEB前端通過采用前沿的

響應(yīng)式、高性能的輕量級(jí)Element+VUE組合框架提高系統(tǒng)的響應(yīng)速度、界面美化、交互體驗(yàn)，主體結(jié)構(gòu)

如圖A.1。

圖A.1主體結(jié)構(gòu)圖

Vue.js+ElementUI

(MVC)

ELK(日志監(jiān)控)

原MinIO

工

始(對(duì)象存儲(chǔ))

統(tǒng)作對(duì)

一象記

流RabbitMQ

權(quán)文錄(消息隊(duì)列)

引模

限擎件

服服Nacos

板配置注冊(cè)中心

服服()

務(wù)務(wù)務(wù)

務(wù)Sentinel

(熔斷限流)

MySQL(關(guān)系型)MongoDB(文檔型)Redis(內(nèi)存型)

A.2結(jié)構(gòu)化數(shù)據(jù)接口示例

A.2.1請(qǐng)求url地址：{url}/api/hm-collect-server/collectionApi/collection/record

A.2.2請(qǐng)求方式：POST

A.2.3請(qǐng)求參數(shù)示例：

{

"cer":"123456",

"uuid":"123456",

"joinId":"123456",

"parentJoinId":"123456",

"factoryNumber":"出廠編號(hào)",

"factory":"生產(chǎn)廠商名稱",

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

"specification":"型號(hào)規(guī)格",

"objectParams":"[{"insParam":"標(biāo)準(zhǔn)砝碼編號(hào)","paramExplain":"結(jié)論"}]",

"paramData":"[{"檢定地點(diǎn)":"方艙實(shí)驗(yàn)室","檢定結(jié)論":"合格"}]"

}

A.2.4joinId/parentJoinId參數(shù)示例：

5

T/ZSMXXXX—XXXX

a)一級(jí)數(shù)據(jù)：

{

"cer":"123456",

"uuid":"123456",

"joinId":"123456",

"parentJoinId":"",

"factoryNumber":"出廠編號(hào)",

"factory":"生產(chǎn)廠商名稱",

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

"specification":"型號(hào)規(guī)格",

"objectParams":"[{"insParam":"標(biāo)準(zhǔn)砝碼編號(hào)","paramExplain":"結(jié)論"}]",

"paramData":"[{"檢定地點(diǎn)":"方艙實(shí)驗(yàn)室","檢定結(jié)論":"合格"}]"

}

b)二級(jí)數(shù)據(jù)：

{

"cer":"123456",

"uuid":"123456",

"joinId":"",

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

"factoryNumber":"出廠編號(hào)",

"factory":"生產(chǎn)廠商名稱",

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

"specification":"型號(hào)規(guī)格",

"objectParams":"[{"insParam":"標(biāo)準(zhǔn)砝碼編號(hào)","paramExplain":"結(jié)論"}]",

"paramData":"[{"檢定地點(diǎn)":"方艙實(shí)驗(yàn)室","檢定結(jié)論":"合格"}]"

}

表A.1請(qǐng)求參數(shù)說明

參數(shù)名說明是否必須備注

cer權(quán)限驗(yàn)證碼是用于校驗(yàn)數(shù)據(jù)來源

uuid樣品唯一標(biāo)識(shí)是用于校驗(yàn)樣品

joinId子數(shù)據(jù)關(guān)聯(lián)標(biāo)識(shí)多級(jí)數(shù)據(jù)時(shí)，做為父級(jí)標(biāo)識(shí)

多級(jí)數(shù)據(jù)時(shí)，做為子級(jí)標(biāo)識(shí)，

parentJoinId上級(jí)數(shù)據(jù)關(guān)聯(lián)標(biāo)識(shí)

關(guān)聯(lián)joinId

factoryNumber樣品出廠編號(hào)

factory制造廠商

customerName委托單位

specification型號(hào)規(guī)格

objectParams對(duì)象參數(shù)說明String格式的json數(shù)據(jù)

paramData采集數(shù)據(jù)包String格式的json數(shù)據(jù)

注：對(duì)象參數(shù)說明/采集數(shù)據(jù)包，至少一個(gè)需要有值

A.2.5返回參數(shù)示例：

{

"status":200,

"message":"操作成功"

}

表A.2返回參數(shù)說明

參數(shù)名說明類型備注

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

status狀態(tài)碼number

態(tài)碼說明400：請(qǐng)求參數(shù)異

6

T/ZSMXXXX—XXXX

參數(shù)名說明類型備注

常，500：接口內(nèi)部服務(wù)異常

等）

message消息String對(duì)本次調(diào)用結(jié)果的中文說明

A.3非結(jié)構(gòu)化數(shù)據(jù)接口示例

A.3.1請(qǐng)求url地址：{url}/api/hm-collect-server/collectionApi/collection/testInfo

A.3.2請(qǐng)求方式：POST

A.3.3請(qǐng)求參數(shù)示例：

{

"cer":"123456",

"uuid":"123456",

"joinId":"123456",

"parentJoinId":"123456",

"objectParams":"[{"insParam":"標(biāo)準(zhǔn)砝碼編號(hào)","paramExplain":"結(jié)論"}]",

"paramData":"[{"檢定地點(diǎn)":"方艙實(shí)驗(yàn)室","檢定結(jié)論":"合格"}]"

}

A.3.4joinId/parentJoinId參數(shù)示例：

a)一級(jí)數(shù)據(jù)：

{

"cer":"123456",

"uuid":"123456",

"joinId":"123456",

"parentJoinId":"",

"objectParams":"[{"insParam":"標(biāo)準(zhǔn)砝碼編號(hào)","paramExplain":"結(jié)論"}]",

"paramData":"[{"檢定地點(diǎn)":"方艙實(shí)驗(yàn)室","檢定結(jié)論":"合格"}]"

}

b)二級(jí)數(shù)據(jù)：

{

"cer":"123456",

"uuid":"123456",

"joinId":"",

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

"objectParams":"[{"insParam":"標(biāo)準(zhǔn)砝碼編號(hào)","paramExplain":"結(jié)論"}]",

"paramData":"[{"檢定地點(diǎn)":"方艙實(shí)驗(yàn)室","檢定結(jié)論":"合格"}]"

}

表A.3請(qǐng)求參數(shù)解釋

參數(shù)名說明是否必須備注

cer權(quán)限驗(yàn)證碼是用于校驗(yàn)數(shù)據(jù)來源

uuid樣品唯一標(biāo)識(shí)是用于校驗(yàn)樣品

joinId子數(shù)據(jù)關(guān)聯(lián)標(biāo)識(shí)多級(jí)數(shù)據(jù)時(shí)，做為父級(jí)標(biāo)識(shí)

多級(jí)數(shù)據(jù)時(shí)，做為子級(jí)標(biāo)識(shí)，

parentJoinId上級(jí)數(shù)據(jù)關(guān)聯(lián)標(biāo)識(shí)

關(guān)聯(lián)joinId

objectParams對(duì)象參數(shù)說明String格式的json數(shù)據(jù)

paramData采集數(shù)據(jù)包String格式的json數(shù)據(jù)

注：對(duì)象參數(shù)說明/采集數(shù)據(jù)包，至少一個(gè)需要有值

A.3.5返回參數(shù)示例：

{

"status":200,

7

T/ZSMXXXX—XXXX

"message":"操作成功"

}

表A.4返回參數(shù)說明

參數(shù)名說明類型備注

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

態(tài)碼說明400：請(qǐng)求參數(shù)異

status狀態(tài)碼number

常，500：接口內(nèi)部服務(wù)異常

等）

message消息String對(duì)本次調(diào)用結(jié)果的中文說明

A.4文件傳輸接口示例

A.4.1請(qǐng)求url地址：{url}/api/hm-collect-server/collectionApi/collection/file

A.4.2請(qǐng)求方式：POST

A.4.3請(qǐng)求參數(shù)：

a)hearders:

表A.5請(qǐng)求參數(shù)說明

參數(shù)名參數(shù)值是否必須備注

Content-Typemultipart/form-data是

b)Body:

表A.6請(qǐng)求參數(shù)說明

參數(shù)名說明是否必須備注

cer權(quán)限驗(yàn)證碼是用于校驗(yàn)數(shù)據(jù)來源

uuid樣品唯一標(biāo)識(shí)是用于校驗(yàn)樣品

joinId子數(shù)據(jù)關(guān)聯(lián)標(biāo)識(shí)多級(jí)數(shù)據(jù)時(shí)，做為父級(jí)標(biāo)識(shí)

多級(jí)數(shù)據(jù)時(shí)，做為子級(jí)標(biāo)識(shí)，

parentJoinId上級(jí)數(shù)據(jù)關(guān)聯(lián)標(biāo)識(shí)

關(guān)聯(lián)joinId

factoryNumber樣品出廠編號(hào)

factory制造廠商

customerName委托單位

specification型號(hào)規(guī)格

collectTime采集時(shí)間yyyy-MM-sshh:mm:ss

需要上傳的文件，是一個(gè)file

file文件是

類型的文件

A.4.4返回參數(shù)示例：

{

"status":200,

"message":"操作成功"

}

表A.7返回參數(shù)說明

參數(shù)名說明類型備注

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

態(tài)碼說明400：請(qǐng)求參數(shù)異

status狀態(tài)碼number

常，500：接口內(nèi)部服務(wù)異常

等）

message消息String對(duì)本次調(diào)用結(jié)果的中文說明

A.5圖片傳輸接口示例

A.5.1請(qǐng)求url地址：{url}/api/hm-shelter/shelters/Collection/Monitoring

8

T/ZSMXXXX—XXXX

A.5.2請(qǐng)求方式：POST

A.5.3請(qǐng)求參數(shù)：

a)hearders:

表A.8請(qǐng)求參數(shù)說明

參數(shù)名參數(shù)值是否必須備注

Content-Typemultipart/form-data是

b)Body:

表A.9請(qǐng)求參數(shù)說明

參數(shù)名參數(shù)值是否必須備注

cer權(quán)限驗(yàn)證碼是用于校驗(yàn)數(shù)據(jù)來源

equipmentId監(jiān)控設(shè)備標(biāo)識(shí)是用于校驗(yàn)監(jiān)控設(shè)備

type數(shù)據(jù)類型是傳入值只能是：

“圖片”或者“視頻”

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

file監(jiān)控?cái)?shù)據(jù)是

文件，是一個(gè)file類型的文件

yyyy-MM-sshh:mm:ss

collectionTime抓拍時(shí)間

圖片的采集時(shí)間

type為“圖片”時(shí)必傳

yyyy-MM-sshh:mm:ss

startTime視頻采集開始時(shí)間

視頻的開始采集時(shí)間

type為“視頻”時(shí)必傳

yyyy-MM-sshh:mm:ss

endTime視頻采集結(jié)束時(shí)間

視頻的結(jié)束采集時(shí)間

type為“視頻”時(shí)必傳

注：采集時(shí)間只需在type為圖片時(shí)傳入。

視頻采集開始/結(jié)束時(shí)間只需在type為視頻時(shí)傳入。

A.5.4返回參數(shù)示例：

{

"status":200,

"message":"操作成功"

}

表A.10返回參數(shù)說明

參數(shù)名說明類型備注

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

態(tài)碼說明400：請(qǐng)求參數(shù)異

status狀態(tài)碼number

常，500：接口內(nèi)部服務(wù)異常

等）

message消息String對(duì)本次調(diào)用結(jié)果的中文說明

A.6視頻數(shù)據(jù)接口示例

A.6.1請(qǐng)求url地址。{url}/api/hm-shelter/shelters/Collection/Monitoring

A.6.2請(qǐng)求方式：POST

A.6.3請(qǐng)求參數(shù)：

a)hearders:

9

T/ZSMXXXX—XXXX

表A.11請(qǐng)求參數(shù)解釋

參數(shù)名參數(shù)值是否必須備注

Content-Typemultipart/form-data是

b)Body:

表A.12請(qǐng)求參數(shù)解釋

參數(shù)名說明是否必須備注

cer權(quán)限驗(yàn)證碼是用于校驗(yàn)數(shù)據(jù)來源

equipmentId監(jiān)控設(shè)備標(biāo)識(shí)是用于校驗(yàn)監(jiān)控設(shè)備

type數(shù)據(jù)類型是傳入值只能是：

“圖片”或者“視頻”

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

file監(jiān)控?cái)?shù)據(jù)是

文件，是一個(gè)file類型的文件

yyyy-MM-sshh:mm:ss

collectionTime