設定Adobe Target API的驗證
Adobe Target Admin API (包括Recommendations Admin API)受到驗證保護,以確保只有授權的使用者才能使用它們來存取Adobe Target。 使用Adobe Developer Console管理所有Adobe Experience Cloud solutions的此驗證,包括Adobe Target。
以下是產生成功與Adobe Target API互動所需的舊版JWT驗證權杖所需的初步步驟:
- 在Adobe Developer Console中建立專案(先前稱為整合)。
- 將專案詳細資料匯出至Postman。
- 產生持有者存取權杖。
- 測試持有者存取權杖。
先決條件
在本指南的其餘部分中假設您熟悉以下資源:
建立Adobe I/O專案
在此區段中,您將存取Adobe Developer Console並建立Adobe Target的專案。 如需詳細資訊,請參考專案🔗上的檔案。
<!—(1. 根據有關驗證🔗的檔案產生您的私密金鑰和公開憑證。 // [//]: # (如的 步驟1 中所述)如何設定AdobeIO:驗證 — 逐步進行。 完成步驟1後,請返回本指南並繼續執行以下步驟2。//此步驟的結果應該是建立private.key
檔案和certificate_pub.crt
檔案。 產生這兩個檔案之後,請回到本指南。)—>
-
在Adobe Admin Console中,確定您的Adobe使用者帳戶已同時授予Target的產品管理員和開發人員層級存取權。
-
在Adobe Developer Console中,選取您要建立此整合的Experience Cloud Organization。 (請注意,您可能只能存取單一Experience Cloud Organization。)
-
按一下 Create new project。
-
按一下 Add API 將REST API新增至您的專案,以存取Adobe服務和產品。
-
選取 Adobe Target 作為您想要整合的Adobe服務。 按一下出現的 Next 按鈕。
-
選取將公開金鑰和私密金鑰與您要為Target建立的服務帳戶整合建立關聯的選項。 在此範例中,選取 Option 1: Generate a key pair 並按一下 Generate keypair。
-
依照指示,記下自動下載的組態檔(
config
),其中包含您的私密金鑰。 按一下 Next。 -
在您的檔案系統中,確認
config
的位置,這是在上一步建立的壓縮組態檔。 同樣地,此config
檔案包含您的私密金鑰,稍後您將需要這些金鑰。 檔案系統內的確切位置可能與此處顯示的位置不同。 -
返回Adobe Developer Console,選取與您使用Adobe Recommendations的屬性相對應的產品設定檔。 (如果您未使用屬性,請選取「預設Workspace」選項)。 按一下 Save configured API。
-
按一下 Create Integration。 您應該會收到暫時訊息,指出您的API已成功設定。
-
最後一個步驟,請將專案重新命名為比原始
Project 1
更有意義的名稱。 若要這麼做,請使用導覽路徑顯示來導覽至專案,按一下 Edit project 以存取 Edit Project 強制回應視窗,然後重新命名專案。
匯出專案詳細資料
現在您已擁有可用於存取Target的Adobe專案,您必須確定已連同您的AdobeAPI要求一起傳送該專案的詳細資料。 需要這些詳細資料才能與多個AdobeAPI互動,包括多個Target API。 例如,整合詳細資料包含Target Admin API所需的授權和驗證資訊。 因此,若要搭配Postman使用API,您必須將這些詳細資料帶入Postman。
有許多方式可在Postman中指定您專案的詳細資料,但在本節中,我們利用了某些預先建立的功能和集合。 首先(在本節中),您會將整合的詳細資訊匯出至Postman環境。 接下來(在以下區段中),您將產生持有者存取權杖,以授予您存取必要Adobe資源的許可權。
-
仍然在Adobe Developer Console中,瀏覽以檢視您新專案的 Service Account (JWT) 認證。 使用左側導覽或 Credentials 區段,如圖所示。
在 Credential details 中,請注意,您可以檢視您的 Public key(s)、Client ID 以及與您的服務帳戶相關的其他資訊。
-
按一下以瀏覽至 Adobe Target API的相關資訊。 使用左側導覽或 連線的產品和服務 區段,如圖所示。
-
按一下「Download for Postman > Service Account (JWT)」以建立擷取Postman環境驗證資訊的JSON檔案。
請記下檔案系統中的JSON檔案。
-
在Postman中,按一下齒輪圖示來管理您的環境,然後按一下 Import 匯入JSON檔案(環境)。
-
選擇您的檔案並按一下 Open。
-
在Postman 管理環境 強制回應視窗中,按一下新匯入的環境名稱以進行檢查。 (您的環境名稱可能與此處顯示的名稱不同。 視需要編輯名稱。 它不一定要與Adobe專案的名稱相符。)
-
注意
CLIENT_SECRET
和API_KEY
(以及其他變數)已預先填入其值,取自您在Adobe Developer Console中定義的整合。 (PostmanCLIENT_SECRET
變數應符合Developer Console中顯示的CLIENT SECRET
個Adobe認證,而Postman中的API_KEY
也應符合Developer Console中的CLIENT ID
。) 相較之下,PRIVATE_KEY
、JWT_TOKEN
和ACCESS_TOKEN
則為空白。 讓我們從提供PRIVATE_KEY
值開始。 -
從您的檔案系統開啟
config
檔案,然後開啟private
金鑰檔案。 -
選取並複製
private
金鑰檔案的整個內容。 -
在Postman中,將您的私密金鑰值貼到 INITIAL VALUE 和 CURRENT VALUE 欄位中。
-
按一下 Update,然後關閉環境強制回應視窗。
產生持有者存取權杖
在本節中,您會產生持有者存取權杖,這是驗證您與Adobe Target API的互動所需的權杖。 若要產生持有者存取權杖,您必須將整合詳細資訊(建立於上述章節)傳送至AdobeIdentity Management服務(IMS)。 有幾種方法可以達成此目的,但在本指南中,我們利用了包含預先建立IMS呼叫的Postman集合,讓程式簡單明瞭。 匯入集合後,您可以視需要重複使用,不僅為Adobe Target產生新權杖,也為其他AdobeAPI產生新權杖。
-
導覽至AdobeIdentity Management服務API範例呼叫。
-
按一下 Adobe I/O Access Token Generation Postman collection。
-
按一下 Raw,然後將產生的JSON複製到剪貼簿,以取得此集合的原始JSON。 (您也可以將原始JSON儲存為.json檔案。)
-
在Postman中,透過貼上並從剪貼簿提交原始JSON來匯入集合。 (您也可以上傳已儲存的.json檔案)。 按一下 Continue。
-
在Adobe I/O存取權杖產生Postman集合中選取 IMS: JWT Generate + Auth via User Token 要求,確定已選取您的環境,然後按一下 Send 以產生權杖。
note note NOTE 此持有者存取權杖的有效期限為24小時。 每當您需要產生新Token時,請再次傳送請求。 -
再次開啟管理環境強制回應視窗,然後選取您的環境。
-
請注意,
ACCESS_TOKEN
和JWT_TOKEN
值現在已填入。
問題:我是否必須使用Adobe I/O存取權杖產生Postman集合來產生JSON Web權杖(JWT)和持有者存取權杖?
答案:否。 Adobe I/O存取權杖產生Postman集合可方便在Postman中更輕鬆地產生JWT和持有者存取權杖。 或者,您可以使用Adobe Developer Console中的功能來手動產生持有者存取權杖。
測試持有者存取權杖
在本練習中,您將傳送從您的Target帳戶中擷取活動清單的API請求,以使用新的持有者存取權杖。 成功的回應表示您的Adobe專案和驗證如預期般運作,才能使用API。
-
匯入Adobe Target Admin API Postman集合。 按照所有提示操作,直到在Postman中匯入集合為止。
-
展開集合,並記下 List activities 請求。
-
請注意,變數(例如
{{access_token}}
)一開始無法解析。 您可以用數種不同的方式解決此問題 — 例如,您可以定義稱為{{access_token}}
的新集合變數 — 但在本指南中,您將改為變更API請求,以運用您先前使用的Postman環境。 如此一來,環境就能繼續以單一、一致的方式整合AdobeAPI間所有通用變數。 -
輸入以以
{{ACCESS_TOKEN}}
取代{{access_token}}
。 -
輸入以以
{{API_KEY}}
取代{{api_key}}
。 -
輸入以以
{{TENANT_ID}}
取代{{tenant}}
。 尚未辨識附註{{TENANT_ID}}
。 -
開啟管理環境強制回應視窗,然後選取您的環境。
-
輸入以新增新的
{{TENANT_ID}}
環境變數。 將您的租使用者ID值複製並貼到新TENANT_ID
環境變數的 INITIAL VALUE 和 CURRENT VALUE 欄位中。note note NOTE 租使用者ID與您的Target clientcode
不同。 當您登入Target時,租使用者ID存在於URL中。 若要取得您的租使用者ID,請登入Adobe Experience Cloud,開啟Target,然後按一下Target卡片。 使用URL子網域中所述的租使用者ID值。 例如,如果您在登入Adobe Target時的URL是<https://mycompany.experiencecloud.adobe.com/...>
,則您的租使用者ID是"mycompany"。 -
在確認您已選取正確的環境後,傳送您的請求。 您應會收到包含活動清單的回應。
現在您已驗證Adobe驗證,您可以用它與Adobe Target API (以及其他AdobeAPI)互動。 例如,您可以使用Recommendations API來建立或管理建議,或者可搭配Target傳送API使用。