工業(yè)互聯(lián)網(wǎng)產(chǎn)業(yè)聯(lián)盟標(biāo)準(zhǔn)工業(yè)互聯(lián)網(wǎng)平臺接口模型規(guī)范InterfaceModelforIndustrialInternetPlatform401401目錄TOC\o"1-5"\h\z范圍1規(guī)范性引用文件1縮略語1工業(yè)互聯(lián)網(wǎng)平臺接口2接口模型2接口組成2功能說明3工業(yè)應(yīng)用接入接口3設(shè)備/產(chǎn)品/服務(wù)接入接口5接口格式要求6工業(yè)應(yīng)用接入接口6設(shè)備/產(chǎn)品/服務(wù)接入接口7接口設(shè)計要求7規(guī)范性7版本控制7參數(shù)說明7數(shù)據(jù)類型7實用性7易用性8接口協(xié)議要求8接口安全要求8接入安全8接口認(rèn)證8數(shù)據(jù)安全9T11/AII001T11/AII001—2018T11/AII001T11/AII001—2018——#—事件類接口事件類應(yīng)包含：消息事件類、報警事件類等接口；其中：消息事件類至少包含：消息事件創(chuàng)建、消息事件設(shè)置、獲取消息事件、消息事件刪除等接口。報警事件類至少包含：報警事件創(chuàng)建、報警事件設(shè)置、獲取報警事件、報警事件刪除、報警事件觸發(fā)等接口。控制類接口控制類應(yīng)包含狀態(tài)控制類、事件控制類等類型接口；其中：狀態(tài)控制類至少包含：設(shè)備/產(chǎn)品開機、設(shè)備/產(chǎn)品關(guān)機、設(shè)備/產(chǎn)品命令下發(fā)等接口。事件控制類至少包含：報警設(shè)置等接口。安全類接口安全類應(yīng)應(yīng)包含設(shè)備/產(chǎn)品認(rèn)證類等類型接口；其中：設(shè)備/產(chǎn)品認(rèn)證類至少包含：獲取認(rèn)證信息、刪除認(rèn)證信息、驗證認(rèn)證信息等接口。接口格式要求工業(yè)互聯(lián)網(wǎng)平臺接口格式要求一般包括：工業(yè)應(yīng)用接入接口a）URL號地址：URL中必須包括版本及通信協(xié)議（HTTP或HTTPS）b）輸入?yún)?shù)：以JSON或XML字符串的方式傳輸c）請求方式：支持create、Retrieve、Update、Delete四種操作。采用HTTP/HTTPS協(xié)議時對應(yīng)綁定到POST、GET、PUT和DELETE方法d）返回值：定義返回值類型JSON或XML格式e）授權(quán)證書：用戶接入接口的授權(quán)碼設(shè)備/產(chǎn)品/服務(wù)接入接口采用HTTP或HTTPS協(xié)議時與工業(yè)應(yīng)用接入接口一致；若是采用MQTT協(xié)議時，接口格式要求如下：a）Broker地址：業(yè)務(wù)網(wǎng)關(guān)域名+端口號b）Payload:支持JSON或二進制c）請求方式：publish（發(fā)布）和subscribe（訂閱）。d）返回值：定義返回值類型JSON或自定義e）授權(quán)證書：用戶接入接口的授權(quán)碼接口設(shè)計要求規(guī)范性版本控制接口應(yīng)進行版本控制，版本之間應(yīng)相互獨立，應(yīng)對版本有詳細描述。參數(shù)說明一個接口包含0個或多個參數(shù)，接口應(yīng)標(biāo)注參數(shù)名稱、是否必選、數(shù)據(jù)類型范圍及參數(shù)示例。數(shù)據(jù)類型調(diào)用接口時，應(yīng)標(biāo)注參數(shù)數(shù)據(jù)類型，以及是否可為空或者默認(rèn)字段。6.2實用性一般要求如下：a）應(yīng)避免接口重復(fù)性，減少請求次數(shù)，提高程序穩(wěn)定性和執(zhí)行效率。宜減少參數(shù)傳遞，按請求情況進行傳遞。易用性一般要求如下：a)接口、參數(shù)命名準(zhǔn)確：接口及參數(shù)包含必要內(nèi)容，易于理解。b)接口狀態(tài)：對于傳輸成功/失敗的情況，接口都必須提供明確的數(shù)據(jù)狀態(tài)信息，都提供返回值。接口可擴展性：方便后期功能性調(diào)整，接口應(yīng)具備可擴展性。接口協(xié)議要求接口應(yīng)支持HTTP/HTTPS、MQTT、和AMQP等協(xié)議中的一種或多種。對于模型類、數(shù)據(jù)類、服務(wù)類、應(yīng)用管理類、安全類應(yīng)支持HTTP/HTTPS協(xié)議。對標(biāo)識類、事件類、運行類、控制類應(yīng)支持HTTP/HTTPS、MQTT和AMQP協(xié)議中的一種或多種。安全類接口中的數(shù)據(jù)加解密類和設(shè)備/產(chǎn)品認(rèn)證類接口也應(yīng)支持MQTT或AMQP協(xié)議。接口安全要求接入安全工業(yè)設(shè)備、服務(wù)、產(chǎn)品接入安全要求見《工業(yè)互聯(lián)網(wǎng)平臺安全防護要求》與《工業(yè)互聯(lián)網(wǎng)安全接入技術(shù)要求》。接口認(rèn)證應(yīng)包含接口調(diào)用認(rèn)證與業(yè)務(wù)用戶認(rèn)證，確保調(diào)用者已經(jīng)獲