Show Menu
主題×

外部 API

說明

此活 External API 動會透過 REST API呼叫,從外部系統 將資料匯入 工作流程中
REST端點可以是客戶管理系統、 Adobe I/O Runtime 實例或Experience Cloud REST端點(資料平台、目標、分析、促銷活動等)。
基於安全性原因,Campaign standard不支援使用JSSP。 如果您需要執行程式碼,可以透過外部API活動呼叫Adobe I/O Runtime例項。
此功能目前為公開測試版。 您必須在開始使用外部API活動之前接受使用協定。 請注意,由於此公開測試版功能尚未由Adobe進行商業性發行,Adobe Client care不支援,因此可能包含錯誤,而且功能可能不如其他已發佈的功能。
本活動的主要特點是:
  • 能夠將JSON格式的資料傳遞至第三方REST API端點
  • 能夠接收回JSON回應、將它對應至輸出表格,並傳遞至下游的其他工作流程活動。
  • 具有出站特定過渡的故障管理
為此活動設定了以下護欄:
  • 5MB http回應資料大小限制
  • 請求逾時為60秒
  • 不允許HTTP重新導向
  • 拒絕非HTTPS Url
  • 「接受:application/json」請求標題和「Content-Type:application/json"回應標題是允許的
請注意,此活動是用於擷取促銷活動範圍資料(最新的選件集、最新的分數等)不用於檢索每個配置檔案的特定資訊,因為這可能導致大量資料被傳輸。 如果使用案例需要此項,建議使用「傳輸檔 」活動。

配置

將活動拖放 External API 到工作流程中,並開啟活動以啟動設定。

入站映射

入站對應是由先前入站活動生成的臨時表,將在UI中顯示為JSON併發送。 根據此臨時表,用戶可以對入站資料進行修改。
「入 站資源 」下拉菜單允許您選擇將建立臨時表的查詢活動。
「添 加計數參數 」複選框將為來自臨時表的每行提供計數值。 請注意,此複選框僅在入站活動生成臨時表時才可用。
「入 站列 」(Inbound Columns)部分允許用戶從入站轉換表中添加任何欄位。 選取的欄將是資料物件中的索引鍵。 JSON中的資料物件將是陣列清單,包含傳入轉場表各列所選欄的資料。
訂參數 文字方塊可讓您新增有效的JSON及外部API所需的其他資料。 此額外資料將新增至產生的JSON中的params物件。

出站映射

此標籤可讓您定義API呼叫傳 回的範例 JSON結構。
JSON結構模式為: {“data”:[{“key”:“value”}, {“key”:“value”},...]}
範例JSON定義必須具有下 列特性 :
  • data 是JSON中的必備屬性名稱,「data」的內容是JSON陣列。
  • 陣列元素 必須包含第一級屬性(不支援較深的層級)。 屬性名 ,最終將成為輸出臨時表的輸出模式的列名。
  • 欄名稱 ,定義是以"data"陣列的第一個元素為基礎。 列定義(添加/刪除)和屬性的類型值可以在「列定義」( Column definition )頁籤中編輯。
如果 驗證瞭解析 ,則會顯示一條消息,邀請您在「列定義」頁籤中自定義資料映射。 在其他情況下,會顯示錯誤訊息。

執行

此標籤可讓您定義 將傳送資料至ACS的HTTPS端點 。 如有需要,您可在下列欄位中輸入驗證資訊。

屬性

此標籤可讓您控 制外部API活動的一般屬性 ,例如UI中顯示的標籤。 無法自訂內部ID。

欄定義

當「出站映射」頁籤 中完成並驗證響應資料格式 時,將顯示此頁籤。
欄定義 」標籤可讓您精確指定每欄的資料結構,以匯入不含任何錯誤的資料,並使其符合Adobe Campaign資料庫中已存在的類型,以供日後作業使用。
例如,您可以變更欄的標籤,並選取其類型(字串、整數、日期等) 甚至指定錯誤處理。
如需詳細資訊,請參閱「載 入檔案 」區段。

轉換

此標籤可讓您啟用 出站轉場 及其標籤。 在逾時或負載超過資料大 小限制 時,此特定轉 換很實用

執行選項

此標籤可用於大部分的工作流活動。 如需詳細資訊,請參閱「活 動屬性 」一節。

疑難排解

此新工作流活動中添加了兩種類型的日誌消息:資訊與錯誤。 它們可協助您疑難排解潛在問題。

資訊

這些日誌消息用於在工作流活動執行期間記錄有關有用檢查點的資訊。 具體來說,下列記錄訊息可用來記錄第一次嘗試存取API的重試嘗試(以及首次嘗試失敗的原因)。
消息格式 Example
叫用API URL '%s'。
叫用API URL 'https://example.com/api/v1/web-coupon?count=2'。
重試API URL '%s',先前嘗試失敗('%s')。
重試API URL 'https://example.com/api/v1/web-coupon?count=2',先前嘗試失敗('HTTP - 401')。
正在傳輸'%s'(%s / %s)的內容。
從'https://example.com/api/v1/web-coupon?count=2'(1234 / 1234)傳輸內容。

錯誤

這些日誌消息用於記錄有關可能最終導致工作流活動失敗的意外錯誤條件的資訊。
代碼——消息格式 Example
WKF-560250 —— 超出API要求內文限制(限制:'%d')。
已超出API要求內文限制(限制:'5242880')。
WKF-560239 —— 超出API回應限制(限制:'%d')。
已超出API回應限制(限制:5242880')。
WKF-560245 —— 無法剖析API URL(錯誤:'%d')。
無法剖析API URL(錯誤:'-2010')。
注意:當API URL失敗驗證規則時,會記錄此錯誤。
WKF-560244 - API URL主機不能是'localhost'或IP位址常值(URL主機:'%s')。
API URL主機不得是'localhost'或IP位址常值(URL主機:'localhost')。
API URL主機不得是'localhost'或IP位址常值(URL主機:192.168.0.5')。
API URL主機不得是'localhost'或IP位址常值(URL主機:'[2001]')。
WKF-560238 - API URL必須是安全URL(https)(請求的URL:'%s')。
API URL必須是安全URL(https)(請求的URL:'https://example.com/api/v1/web-coupon?count=2')。
WKF-560249 —— 無法建立請求內文JSON。 添加「%s」時出錯。
無法建立請求正文JSON。 添加'params'時出錯。
無法建立請求正文JSON。 新增「資料」時發生錯誤。
WKF-560246 - HTTP標頭鍵錯誤(標頭鍵:'%s')。
HTTP標頭鍵錯誤(標頭鍵:'%s')。
注意:當自定義標頭密鑰根據 RFC驗證失敗時,將記錄此錯誤
WKF-560248 —— 不允許HTTP標頭鍵(標頭鍵:'%s')。
不允許HTTP標題鍵(標題鍵:'接受')。
WKF-560247 - AHTTP標頭值錯誤(標頭值:'%s')。
HTTP標頭值錯誤(標頭值:'%s')。
注意:當自定義標頭值根據 RFC驗證失敗時,將記錄此錯誤
WKF-560240 - JSON裝載有不良屬性'%s'。
JSON裝載包含不正確的屬性'plash'。
WKF-560241 —— 格式錯誤的JSON或不可接受的格式。
格式錯誤的JSON或不可接受的格式。
注意:此訊息僅適用於從外部API剖析回應內文,並在嘗試驗證回應內文是否符合本練習規定的JSON格式時記錄。
WKF-560246 —— 活動失敗(原因:'%s')。
當活動因HTTP 401錯誤回應而失敗時——活動失敗(原因:'HTTP - 401')
當活動因內部呼叫失敗而失敗時——活動失敗(原因:'iRc - -Nn')。
當活動因無效的內容類型標題而失敗時。 -活動失敗(原因:'Content-Type - application/html')。