設定Developer Console和Postman
在本課程中,您將會在Adobe Developer Console中設定專案並下載Postman集合,以便開始使用Platform API。
為了完成本教學課程中的API練習,下載適用於您作業系統的Postman應用程式。雖然使用Experience Platform API並非必要,但Postman可簡化API工作流程,而Adobe Experience Platform可提供數十個Postman集合來協助您執行API呼叫並瞭解其運作方式。 本教學課程的其餘部分假設您具備Postman的一些實用知識。 如需協助,請參考Postman檔案。
平台是API優先建置。 雖然所有主要工作都有介面選項,但您在某些時候可能想要使用平台API。 例如,若要內嵌資料、在沙箱之間移動專案、自動化例行工作或在建置使用者介面之前使用新Platform功能。
資料架構師 和 資料工程師 可能需要在本教學課程之外使用Platform API。
需要的許可權
在設定許可權課程中,您已設定完成本課程所需的所有存取控制。
設定Adobe Developer Console
Adobe Developer Console是開發人員目的地,可存取AdobeAPI和SDK、接聽近乎即時的事件、在執行階段上執行函式,或建置外掛程式或App Builder應用程式。 您將用它來存取Experience Platform API。 如需詳細資訊,請參閱Adobe Developer Console檔案
-
在本機電腦上建立名為
Luma Tutorial Assets
的資料夾,以用於教學課程中使用的檔案。 -
登入並確認您隸屬於正確的組織
-
在快速入門功能表中選取 建立新專案。
-
在新建立的專案中,選取 編輯專案 按鈕
-
將「專案標題」變更為「
Luma Tutorial API Project
」(如果貴公司的多人參加此教學課程,請在結尾加上您的姓名) -
選取 儲存
-
選取 新增API
-
選取 Adobe Experience Platform 以篩選清單
-
在可用API清單中,選取 Experience PlatformAPI,然後選取 下一步。
-
選取 OAuth伺服器對伺服器 作為認證,並選取 下一步。
-
選取
AEP-Default-All-Users
產品設定檔,然後選取 儲存已設定的API -
現在您的Developer Console專案已建立!
-
在頁面的 試用它 區段中,選取 下載適用於Postman 的,然後選取 OAuth伺服器對伺服器 以下載Postman環境json檔案。 將
oauth_server_to_server.postman_environment.json
儲存在您的Luma Tutorial Assets
資料夾中。
請系統管理員將API認證新增至角色
若要使用API認證與Experience Platform互動,您必須讓系統管理員將API認證指派給上堂課中建立的角色。 如果您不是系統管理員,請傳送給他們:
-
您的API認證(
Credential in Luma Tutorial API Project
)的名稱 -
您認證的技術帳戶電子郵件 (這將有助於系統管理員找到認證)
以下是系統管理員的指示:
-
在左側導覽中選取「許可權」,系統會將您帶至「角色」畫面
-
開啟
Luma Tutorial Platform
角色
-
選取 API認證 標籤
-
選取 新增API認證
-
如果清單很長,請尋找由教學課程參與者提供的
Credential in Luma Tutorial API Project
認證,並以技術帳戶電子郵件進行篩選 -
選取認證
-
選取 儲存
設定Postman
-
下載並安裝Postman
-
開啟Postman並建立工作區
-
匯入下載的json環境檔案,
oauth_server_to_server.postman_environment.json
-
在Postman中,在下拉式清單中選取您的環境
-
選取圖示以檢視環境變數:
新增沙箱名稱和租使用者ID
SANDBOX_NAME
和TENANT_ID
以及CONTAINER_ID
變數未包含在Adobe Developer Console匯出中,因此我們會手動新增它們:
-
在Postman中,開啟 環境變數
-
選取環境名稱右側的 編輯 連結
-
在 新增變數欄位 中,輸入
SANDBOX_NAME
-
在這兩個值欄位中,輸入
luma-tutorial
,也就是我們在上一堂課中為沙箱提供的名稱。 如果您對沙箱使用不同的名稱,例如luma-tutorial-ignatiusjreilly,請務必使用該值。 -
在 新增變數欄位 中,輸入
TENANT_ID
-
切換至您的網頁瀏覽器,並前往Experience Platform的介面擷取@符號 之後的URL 部分,以查詢您公司的租使用者ID。 例如,我的租使用者ID是
techmarketingdemos
,但您的不同: -
複製此值並返回Postman管理環境畫面
-
將您的租使用者id貼到兩個值欄位
-
在 新增變數欄位 中,輸入
CONTAINER_ID
-
在兩個值欄位中輸入
global
note note NOTE CONTAINER_ID
是一個欄位,其值在教學課程中會變更多次。 使用global
時,API會與您Platform帳戶中Adobe提供的元素互動。 使用tenant
時,API會與您自己的自訂元素互動。 -
選取 儲存
進行API呼叫
擷取存取權杖
Adobe提供了一組豐富的Postman集合,可幫助您探索Experience Platform的API。 這些集合位於Adobe Experience Platform Postman Samples GitHub存放庫中。 您應該將此存放庫加入書籤,因為在本教學課程中會多次使用此存放庫,之後當您為自己的公司實作Experience Platform時,也會使用此存放庫。
第一個集合適用於Adobe Identity Management Service (IMS) API。 這是從Postman中擷取存取權杖的便利方式。
若要產生存取權杖:
-
將Identity Management Service API集合下載至您的
Luma Tutorial Assets
資料夾 -
將集合匯入Postman
-
選取要求 oAuth:要求存取權杖 要求,並選取 傳送
-
您應該在回應中取得具有存取權杖的
200 OK
回應 -
存取權杖應自動儲存為Postman環境的 ACCESS_TOKEN 環境變數。
與平台API互動
現在,讓我們進行Platform API呼叫,以確認我們已正確設定所有專案。
在GitHub🔗中開啟Experience Platform Postman 集合。 此頁面上有許多適用於各種Platform API的集合。 我強烈建議將它加入書籤。
現在,讓我們進行第一個API呼叫:
- 將結構描述登入API集合下載至您的
Luma Tutorial Assets
資料夾 - 將其匯入Postman
- 開啟 結構描述登入API >結構描述>清單結構描述
- 檢視 Params 和 Headers 標籤,並注意它們如何包含我們先前輸入的一些環境變數。
- 請注意,Headers > Accept值欄位 已設定為
application/vnd.adobe.xed-id+json
。 結構描述登入API需要這些指定的Accept標頭值之一,這些值在回應中提供不同的格式。 - 選取 傳送 以進行您的第一個Platform API呼叫!
希望您得到成功的200 OK
回應,其中包含沙箱中可用Adobe提供的XDM結構描述清單,如下圖所示。
Postman中的
如果您的呼叫失敗,請花點時間使用API呼叫的錯誤回應詳細資料進行偵錯,並檢閱上述步驟。 如果您卡住了,請在社群論壇尋求協助,或使用本頁右側的連結「登入問題」。
設定好Platform許可權、沙箱和Postman後,您就可以在結構描述中建立資料模型!