外部資料來源可讓您定義與協力廠商系統的連線,例如使用飯店訂房系統來檢查某人是否已登記客房。與內建的 Adobe Experience Platform 資料來源不同,您可以視需要儘量建立外部資料來源。
支援使用 POST 或 GET 以及傳回 JSON 的 REST API。支援 API 金鑰、基本和自訂驗證模式。
我們以一個氣象 API 服務為例,我想利用它根據即時氣象資料來自訂歷程的行為。
以下是 API 呼叫的兩個範例:
此呼叫由主要 URL (https://api.adobeweather.org/weather)、兩個參數集 ("city" 代表城市、"lat/long" 代表經緯度)和 API 金鑰 (appid) 組成。
以下是建立和設定新外部資料來源的主要步驟:
從資料來源清單中,按一下 Add 以建立新的外部資料來源。
這會開啟畫面右側的資料來源設定窗格。
輸入您的資料來源名稱。
請勿使用空格或特殊字元。請勿使用超過 30 個字元。
新增說明至您的資料來源。此步驟為選填。
新增外部服務的 URL。在我們的範例中:https://api.adobeweather.org/weather。
基於安全考量,我們強烈建議您使用 HTTPS。另請注意,我們不允許使用非公開的 Adobe 網址和 IP 位址。
根據外部服務配置設定身份驗證:No authentication、Basic、Custom 或 API key。有關自定義身份驗證模式的詳細資訊,請參閱本節。 在我們的範例中,我們選擇:
按一下 Add a New Field Group,為每個 API 參數集新增欄位群組。請勿在欄位群組名稱中使用空格或特殊字元。在我們的範例中,我們需要建立兩個欄位群組,每個群各有一個參數集(city 及 long/lat)。
在 "long/lat" 參數集中,我們會建立包含下列資訊的欄位群組:
若是 GET 呼叫所需的參數,您會在 Parameters 欄位中輸入參數,系統就會在呼叫結束時自動新增這些參數。若是 POST 呼叫,您需要:
在 Parameter 欄位中列出呼叫時要傳遞的參數(在以下範例中:“identifier”)。
在已傳送有效負載的正文中,也使用完全相同的語法指定它們。若要這麼做,您必須新增:"param": “name of your parameter”(在以下範例中:“identifier”)。請遵循下列語法:
{"id":{"param":"identifier"}}
按一下 Save。
資料來源現在已設定完畢,且可供您在歷程中使用,例如在您的條件或個人化電子郵件中。如果溫度超過 30°C,您可以決定傳送特定通訊。
此驗證模式會用於複雜驗證,常用來呼叫 OAuth2 這類 API 封裝通訊協定,以擷取要插入到動作之實際 HTTP 要求中的存取權杖。
當您設定自訂驗證時,可以按一下下方的按鈕,以檢查自訂驗證有效負載是否已正確設定。
如果測試成功,按鈕就會變成綠色。
使用此驗證的話,動作執行會是兩個步驟的流程:
此驗證分為兩個部分。
要呼叫的端點定義,用於產生存取權仗:
存取權杖插入動作之 HTTP 要求必須採用的方法定義:
authorizationType:定義如何將產生的存取權杖插入到動作的 HTTP 要求。可能的值包括:
tokenInResponse:表示如何從驗證呼叫中擷取存取權杖。此屬性可以是:
此驗證的格式為:
{
"type": "customAuthorization",
"authorizationType": "<value in 'bearer', 'header' or 'queryParam'>",
(optional, mandatory if authorizationType is 'header' or 'queryParam') "tokenTarget": "<name of the header or queryParam if the authorizationType is 'header' or 'queryParam'>",
"endpoint": "<URL of the authentication endpoint>",
"method": "<HTTP method to call the authentication endpoint, in 'GET' or 'POST'>",
(optional) "headers": {
"<header name>": "<header value>",
...
},
(optional, mandatory if method is 'POST') "body": {
"bodyType": "<'form'or 'json'>,
"bodyParams": {
"param1": value1,
...
}
},
"tokenInResponse": "<'response' or json selector in format 'json://<field path to access token>'"
}
您可以針對自訂驗證資料來源變更權杖之快取期間的資訊。以下是自訂驗證有效負載的範例。會在 "cacheDuration" 參數中定義快取期間。其會指定快取中產生權杖的保留期間。單位可能是毫秒、秒、分鐘、小時、天、月、年。
"authentication": {
"type":"customAuthorization",
"authorizationType":"Bearer",
"endpoint":"http://localhost:${port}/epsilon/oauth2/access_token",
"method":"POST",
"headers": {
"Authorization":"Basic EncodeBase64(${epsilonClientId}:${epsilonClientSecret})"
},
"body": {
"bodyType":"form",
"bodyParams": {
"scope":"cn mail givenname uid employeeNumber",
"grant_type":"password",
"username":"${epsilonUserName}",
"password":"${epsilonUserPassword}"
}
},
"tokenInResponse":"json://access_token",
"cacheDuration":
{ "duration":5, "timeUnit":"seconds" }
}