集成阿里云 OpenAPI
魔筆平臺(tái)提供了強(qiáng)大的阿里云 OpenAPI 集成功能,允許用戶(hù)通過(guò)簡(jiǎn)單的配置,實(shí)現(xiàn)對(duì)阿里云 OpenAPI 接口的無(wú)縫連接和數(shù)據(jù)交互。本文檔將指導(dǎo)您如何創(chuàng)建和使用阿里云 OpenAPI 集成。
功能介紹
魔筆平臺(tái)的阿里云 OpenAPI 集成功能支持以下特點(diǎn):
自定義觸發(fā)方式:集成操作可以設(shè)置為手動(dòng)觸發(fā)或自動(dòng)運(yùn)行,滿足不同的業(yè)務(wù)場(chǎng)景需求。
回調(diào)和數(shù)據(jù)轉(zhuǎn)換:支持在查詢(xún)成功或失敗時(shí)執(zhí)行特定的集成操作事件,以及對(duì)返回的數(shù)據(jù)進(jìn)行自定義處理。
高級(jí)設(shè)置:提供防抖和禁止執(zhí)行條件的高級(jí)配置,以?xún)?yōu)化集成操作的執(zhí)行。
事件相關(guān)內(nèi)容可參考:集成操作事件
使用阿里云 OpenAPI 集成
步驟 1:創(chuàng)建阿里云 OpenAPI 集成
登錄魔筆平臺(tái),進(jìn)入管控臺(tái)。
導(dǎo)航至“資源”->“集成”,點(diǎn)擊“創(chuàng)建集成”。
選擇“阿里云 OpenAPI”,并填寫(xiě)集成名稱(chēng)及描述。
配置不同環(huán)境的阿里云 OpenAPI 集成信息,包括
產(chǎn)品
、版本
、地域
和訪問(wèn)密鑰
等。產(chǎn)品:定義了預(yù)期發(fā)起阿里云 OpenAPI 請(qǐng)求的產(chǎn)品。
版本:定義了預(yù)期發(fā)起阿里云 OpenAPI 請(qǐng)求產(chǎn)品的版本。
地域:定義了預(yù)期發(fā)起阿里云 OpenAPI 請(qǐng)求的地域信息。
訪問(wèn)密鑰:定義了預(yù)期發(fā)起 OpenAPI 請(qǐng)求所使用的訪問(wèn)密鑰,關(guān)于訪問(wèn)密鑰,可以參考創(chuàng)建AccessKey。
說(shuō)明阿里云 OpenAPI 產(chǎn)品、版本和地域信息,可以參考阿里云 OpenAPI 開(kāi)發(fā)者門(mén)戶(hù)。
點(diǎn)擊“確定”以創(chuàng)建阿里云 OpenAPI 集成。
步驟 2:在應(yīng)用內(nèi)部創(chuàng)建集成操作
打開(kāi)“代碼”面板,點(diǎn)擊對(duì)應(yīng)作用域的“+”后選中“集成操作”。
選擇之前創(chuàng)建的阿里云 OpenAPI 集成作為資源,選擇 API 后會(huì)展開(kāi)該 API 下的所有參數(shù),配置參數(shù)后點(diǎn)擊運(yùn)行以獲取接口的返回結(jié)果。
必填參數(shù):定義了調(diào)用該集成操作時(shí)的必填參數(shù),需要配置參數(shù)名和類(lèi)型。在接口參數(shù)中,可通過(guò)
{{ varName }}
的方式引用參數(shù)。可選參數(shù):定義了調(diào)用該集成操作時(shí)的可選參數(shù),需要配置參數(shù)名和類(lèi)型,支持配置默認(rèn)值。在接口參數(shù)中,可通過(guò)
{{ varName }}
的方式引用參數(shù)。API:定義了預(yù)期調(diào)用的阿里云 OpenAPI 服務(wù)的產(chǎn)品接口。
protocol: 定義了預(yù)期調(diào)用的阿里云 OpenAPI 服務(wù)的協(xié)議。
method:定義了預(yù)期調(diào)用的 OpenAPI 服務(wù)的方法。
其他參數(shù):根據(jù)所選擇的 API 會(huì)自動(dòng)生成該接口的參數(shù)配置項(xiàng),用于傳遞該 API 需要的參數(shù),必填參數(shù)會(huì)在該參數(shù)名后以紅色星號(hào)標(biāo)識(shí)。
點(diǎn)擊“運(yùn)行”預(yù)覽查詢(xún)效果。
配置面板詳解
回調(diào)配置
數(shù)據(jù)轉(zhuǎn)化:對(duì)接口返回的數(shù)據(jù)進(jìn)行處理,默認(rèn)為
return data
,即不進(jìn)行處理。成功回調(diào):配置接口調(diào)用成功時(shí)觸發(fā)的事件。
失敗回調(diào):配置接口調(diào)用失敗時(shí)觸發(fā)的事件。
高級(jí)配置
防抖:設(shè)置防抖表達(dá)式,避免接口的頻繁調(diào)用。
禁止執(zhí)行條件:根據(jù)條件表達(dá)式確定是否執(zhí)行此集成操作。
手動(dòng)觸發(fā)集成
事件觸發(fā)
在需要觸發(fā)集成操作的組件中,配置事件處理器。
將動(dòng)作類(lèi)型設(shè)置為集成操作,并選擇相應(yīng)的集成。
以對(duì)象形式填寫(xiě)已配置的參數(shù)。
API 觸發(fā)
若此集成操作的名稱(chēng)為action1
,則在任何可以執(zhí)行腳本的地方,可以使用action1.trigger()
方法觸發(fā)集成操作,若集成操作配置了參數(shù),則需要以對(duì)象形式填寫(xiě)已配置的參數(shù)。