調用 API 欄位

一、功能簡介

調用 API 欄位允許您在表單中添加一個自訂按鈕,使用者點擊該按鈕後,系統會將表單中指定欄位的資料作為參數,發送給外部的 API(例如 YOOV AI Chain 中的 AI 應用)進行處理,並將返回的結果自動填入到表單的對應欄位中。

此功能極大地擴展了表單的處理能力,例如:

  • 根據填寫的出發地、目的地和日期,點擊按鈕自動生成並回填「行程安排」。

  • 將大段文字發送至翻譯 API,自動將翻譯結果回填至指定欄位。

  • 根據輸入的產品描述,調用外部 AI 應用自動生成營銷文案。

二、前置準備:配置 API 授權

在表單中使用調用 API 欄位前,管理員需要先在系統中配置 API 的授權令牌(Token)。目前系統支援接入 YOOV 旗下的 YOOV AI Chain 產品。

1. 獲取訪問令牌

YOOV AI Chainarrow-up-right 平台中,生成並複製您的 API 訪問令牌(API Key)。

2. 在系統中配置授權

1

進入「授權管理」頁面

進入系統的 團隊管理 > 授權管理 頁面。

2

新建調用 API 令牌

點擊右上角的 新建 按鈕,選擇 調用 API

3

填寫令牌資訊

在彈出的「新建令牌」視窗中,填寫 令牌名稱,並將剛剛獲取的 令牌(API Key) 貼上至對應輸入框,點擊確認。

4

授權應用範圍

建立完成後,在授權列表中找到該令牌,點擊右側的 操作 > 授權應用,選擇允許使用此 API 的應用範圍。

完成上述配置後,您就可以在表單設計中選擇並使用這個 API 連接了。

三、操作流程

進入欄位配置介面

  1. 進入目標應用的表單設計介面。

  2. 點擊左側導航欄中的 AI 場景頁籤。

  3. 調用 API 欄位拖曳至表單設計區域中,右側即會彈出欄位屬性面板。

配置調用 API 欄位

在屬性面板中,您需要完成以下配置:

1

基本屬性設置

  • 欄位名稱:在表單設計器中顯示的控制項名稱(例如:調用API)。

  • 按鈕名稱:實際展示給使用者點擊的按鈕文字(例如:生成行程、開始翻譯)。

2

選擇 API 連接與介面

  • 選擇 API 連接:在下拉選單中選擇您在「授權管理」中配置好的令牌(例如:行程規劃)。

  • 選擇 API:選擇該連接下具體要調用的 API 介面(例如:行程規劃)。

3

配置輸入參數

系統會自動讀取所選 API 需要的輸入參數列表。您需要將表單中的欄位與這些參數進行綁定。

例如,API 需要「出發日期」、「返回日期」、「目的地」等參數,您可以點擊輸入框右側的圖示,選擇表單中對應的欄位作為變數傳入。

4

配置返回參數(映射關係)

點擊 返回參數設置 按鈕,在彈出的「映射關係設置」視窗中,設定 API 返回的結果要填入表單的哪個欄位。

  • 識別欄位:API 返回資料中的欄位名稱(例如:output)。

  • 工作表欄位:選擇接收該資料的表單欄位(例如:「行程安排」富文本欄位)。

其他配置項

  • 欄位權限:可見、新建記錄時隱藏。

  • 欄位寬度:可定義控制項在表單頁面的寬度(1/4、1/3、1/2、2/3、3/4、1)。

  • 描述信息:為該按鈕添加補充說明文字。

實際運行效果

配置完成後,在表單記錄的填寫或編輯頁面中,會顯示您設定的按鈕。

點擊前:

使用者先在表單中填寫所需的基礎資訊(如出發日期:2026-03-01,目的地:廣東省/廣州市,出行方式:飛機等)。此時「行程安排」欄位為空。

點擊後:

使用者點擊 調用 API 按鈕。系統會讀取表單中的資訊發送給 AI,處理完成後,生成的「廣州六日五夜深度文化美食之旅」詳細行程規劃會自動填入並顯示在「行程安排」欄位中。

四、注意事項

  • 參數完整性:在點擊調用按鈕前,請確保作為「輸入參數」的表單欄位均已填寫完整,否則可能導致 API 調用失敗或返回結果不準確。

  • 等待時間:點擊按鈕後,根據 API 處理的複雜度,可能需要短暫的等待時間。處理期間請勿關閉頁面。

  • 覆蓋規則:如果「工作表欄位」(接收結果的欄位)中原本已有內容,API 返回的新結果將會 覆蓋 原有內容,請謹慎操作。

Last updated

Was this helpful?