HTTP請(qǐng)求節(jié)點(diǎn)是創(chuàng)建API服務(wù)的開始節(jié)點(diǎn),通過該節(jié)點(diǎn)可配置API的請(qǐng)求參數(shù)和SDK調(diào)用時(shí)的Action。每個(gè)API有且僅有一個(gè)HTTP請(qǐng)求節(jié)點(diǎn),中間邏輯節(jié)點(diǎn)可根據(jù)業(yè)務(wù)需要選擇其他功能節(jié)點(diǎn),但必須以HTTP返回節(jié)點(diǎn)作為終止節(jié)點(diǎn)。開發(fā)的API可被外部調(diào)用,也可用于Web可視化開發(fā)。

前提條件

已完成業(yè)務(wù)服務(wù)的創(chuàng)建。詳細(xì)內(nèi)容請(qǐng)參見創(chuàng)建業(yè)務(wù)服務(wù)

節(jié)點(diǎn)配置

在業(yè)務(wù)邏輯開發(fā)編輯頁面的節(jié)點(diǎn) > 觸發(fā)列表中,拖拽HTTP請(qǐng)求節(jié)點(diǎn)到中間畫布并進(jìn)行配置,如圖所示。

http請(qǐng)求
配置項(xiàng) 說明
節(jié)點(diǎn)名稱 支持中文漢字、英文字母、數(shù)字和下劃線(_)。長度不超過30個(gè)字符。
Action 設(shè)置調(diào)用API時(shí),參數(shù)Action的值。可包含英文大小寫字母和數(shù)字。
賬號(hào)鑒權(quán) 選中后,開啟賬號(hào)鑒權(quán)。只有登錄賬號(hào)后才能調(diào)用該服務(wù),且需要與IoT Studio的Web可視化應(yīng)用配合使用。有關(guān)賬號(hào)的詳細(xì)內(nèi)容,請(qǐng)參見賬號(hào)鑒權(quán)
訪問限制 選中后,需要管理員在運(yùn)營后臺(tái)配置可調(diào)用該服務(wù)的角色,詳細(xì)內(nèi)容,請(qǐng)參見賬號(hào)
入?yún)⑴渲?/td> 根據(jù)業(yè)務(wù)需要,設(shè)置調(diào)用API的請(qǐng)求參數(shù)。單擊+添加入?yún)?/span>,參數(shù)設(shè)置包含:
  • 參數(shù)名稱:支持英文大小寫字母、數(shù)字和下劃線(_),且必須以英文字母開頭。長度不超過50個(gè)字符。
  • 類型:參數(shù)的數(shù)據(jù)類型,支持String、Int、Long、Float、Double、Boolean。
  • 是否必填:該參數(shù)是否為必傳參數(shù)。若選擇必填項(xiàng),IoT Studio平臺(tái)會(huì)校驗(yàn)API調(diào)用請(qǐng)求中是否包含了此參數(shù),若請(qǐng)求中沒有此參數(shù)或參數(shù)類型錯(cuò)誤,則拒絕請(qǐng)求。
  • 默認(rèn)值(可選):為參數(shù)設(shè)置默認(rèn)值。如果該參數(shù)為非必填,調(diào)用API時(shí),若沒有傳入該參數(shù)的值,則使用默認(rèn)值。
  • 描述:輸入?yún)?shù)的用途、使用注意事項(xiàng)等。

節(jié)點(diǎn)輸出

調(diào)用成功時(shí)的輸出數(shù)據(jù)格式示例如下。

{
        "code": 200,
        "data": {
            "入?yún)⒚?": 參數(shù)值1,
            "入?yún)⒚?": 參數(shù)值2
        },
        "message": "success",
        "localizedMsg": "成功"

}

調(diào)用失敗的輸出數(shù)據(jù),請(qǐng)查看節(jié)點(diǎn)日志。

該節(jié)點(diǎn)輸出數(shù)據(jù)的使用方法

配置后續(xù)節(jié)點(diǎn)時(shí),可通過以下方式調(diào)用輸出數(shù)據(jù)中某字段的值來使用。

  • 以query方式調(diào)用具體的參數(shù)字段。

    例如腳本節(jié)點(diǎn)或釘釘機(jī)器人節(jié)點(diǎn),編輯內(nèi)容時(shí),可使用query.入?yún)⒚?/code>結(jié)構(gòu)調(diào)用API的入?yún)⒅怠?

    • 釘釘機(jī)器人消息示例
    • 腳本節(jié)點(diǎn)代碼示例
  • 將本節(jié)點(diǎn)選擇為后續(xù)節(jié)點(diǎn)輸入源。

    例如條件判斷或路徑選擇節(jié)點(diǎn),選擇數(shù)據(jù)源為HTTP請(qǐng)求中的某個(gè)請(qǐng)求參數(shù)。

    后續(xù)節(jié)點(diǎn)

API調(diào)用方法

發(fā)布HTTP業(yè)務(wù)服務(wù)后,在業(yè)務(wù)邏輯開發(fā)工作臺(tái),單擊左側(cè)導(dǎo)航欄的服務(wù)調(diào)用設(shè)置按鈕設(shè)置。根據(jù)實(shí)際需求在API調(diào)用方式頁簽的請(qǐng)求示例中,獲取調(diào)用方法。

說明 您可單擊域名管理頁簽,根據(jù)頁面提示自定義API的訪問域名。
請(qǐng)求示例