API

添加云函數(shù)

1、點擊云函數(shù)下方的"添加API"按鈕，在API模板界面點擊“新建空白API”，在彈出窗口中輸入API名稱，點擊確定。

2、在配置頁配置輸入、輸出參數(shù)、并填寫配置表。

3、切換至“編程”標(biāo)簽，現(xiàn)在您可以在代碼編輯器中定義云函數(shù)了。如果你熟悉JS腳本語言，編寫API非常簡單，你只需要在run方法中補(bǔ)充您的業(yè)務(wù)邏輯代碼就可以了。

run方法包含了3個參數(shù)

input：輸入?yún)?shù)。通過“input.key”調(diào)用配置中添加的輸入?yún)?shù)。

output：輸出參數(shù)。通過“output.key”調(diào)用配置中添加的輸出參數(shù)。

modules：可調(diào)用模塊。

詳情請參考API開發(fā)文檔_白碼。

1、新增云函數(shù)

2、編輯云函數(shù)的配置項

3、在編輯中編寫代碼

4、平臺支持調(diào)試api

通過在線調(diào)試工具測試結(jié)果(測試前請請先將代碼保存，并保持開啟狀態(tài))：

調(diào)用云函數(shù)

1、在調(diào)用云函數(shù)前，請確保云函數(shù)測試無誤可用，并將云函數(shù)啟用(在云函數(shù)的基本信息中將狀態(tài)開關(guān)打開即可。

2、創(chuàng)建一個功能，進(jìn)入功能編輯頁，添加一個步驟，類型選擇“API”，操作選擇“自定義api”，模板選擇開啟的云函數(shù)。

3、點擊此步驟的編輯，即可看到此API包含的輸入輸出參數(shù)?，F(xiàn)在你可以將輸入?yún)?shù)設(shè)為其他步驟中的相關(guān)數(shù)值，以傳入云函數(shù)

4、創(chuàng)建一個步驟來使用API的輸出參數(shù)。

api返回的處理時長

webhook

添加webhook

1、點擊webhook下方的"添加API"按鈕，在API模板界面點擊“新建空白API”，在彈出窗口中輸入API名稱，設(shè)定webhook路徑(此路徑為第三方發(fā)起該webhook請求的路徑)，點擊確定。

2、在配置頁填寫配置表。

3、切換至“編程”標(biāo)簽，現(xiàn)在您可以在代碼編輯器中定義webhook了。如果你熟悉JS腳本語言，編寫API非常簡單，你只需要在hook方法中補(bǔ)充您的業(yè)務(wù)邏輯代碼就可以了。

hook方法包含了3個參數(shù)：

req：請求對象，可以獲取網(wǎng)絡(luò)請求中的參數(shù)。

resp：回應(yīng)對象，可以將webhook的執(zhí)行結(jié)果返回到請求方。

modules：可調(diào)用模塊。

詳情請參考API開發(fā)文檔_白碼。

由于webhook屬于被動式接收數(shù)據(jù)，而功能屬于主動式處理，因此不支持在功能步驟中處理webhook接收的數(shù)據(jù)。需要在webhook中通$modules.program.exec（$flow,$form）調(diào)用一個功能來記錄處理接收的數(shù)據(jù)。

這里以實現(xiàn)在接收企業(yè)微信接口文檔 - 企業(yè)微信開發(fā)者中心回調(diào)數(shù)據(jù)的功能為例介紹webhook具體使用流程：根據(jù)企業(yè)微信API模板創(chuàng)建一個API實現(xiàn)記錄成員添加外部聯(lián)系人信息。

API配置如下：

代碼如下：

調(diào)用功能如下：

調(diào)用webhook

以上文配置的webhook為例：

1、保證API編寫無誤后，將API保持開啟狀態(tài)。

2、在第三方配置此webhook的路徑。

3、在第三方觸發(fā)回調(diào)事件，在白碼數(shù)據(jù)庫查看回調(diào)信息。

1）使用企業(yè)微信成員賬號將微信用戶“添加為聯(lián)系人”

2）在數(shù)據(jù)庫中查看回調(diào)數(shù)據(jù)