設定OpenAPI型AEM API

瞭解如何設定您的AEM as a Cloud Service環境,以啟用對OpenAPI型AEM API的存取權。

高層級設定程式涉及下列步驟:

  1. AEM as a Cloud Service環境的現代化。
  2. 啟用AEM API存取權。
  3. 建立Adobe Developer Console (ADC)專案。
  4. 設定ADC專案。
  5. 設定AEM執行個體以啟用ADC專案通訊。

AEM as a Cloud Service環境的現代化 modernization-of-aem-as-a-cloud-service-environment

AEM as a Cloud Service環境的現代化是一項針對每個環境的一次性活動,其中涉及以下步驟:

  • 更新至AEM版本​ 2024.10.18459.20241031T210302Z ​或更新版本。
  • 如果環境是在2024.10.18459.20241031T210302Z版之前建立,請新增產品設定檔。

更新AEM執行個體 update-aem-instance

若要更新AEM執行個體,請在Adobe Cloud Manager的​ 環境 ​區段中,選取環境名稱旁的​ 省略符號 ​圖示,並選取​ 更新 ​選項。

更新AEM執行個體

然後按一下​ 提交 ​按鈕並執行​ 建議 ​全棧疊管道。

選取最新的AEM發行版本

在我的案例中,Fullstack管道名為​ Dev :: Fullstack-Deploy,而AEM環境名為​ wknd-program-dev。 您的名稱可能不同。

新增產品設定檔 add-new-product-profiles

若要將產品設定檔新增至AEM執行個體,請在Adobe Cloud Manager的​ 環境 ​區段中,選取環境名稱旁的​ 省略符號 ​圖示,並選取​ 新增產品設定檔 ​選項。

新增產品設定檔

您可以按一下環境名稱旁的​ 省略符號 ​圖示,並選取​ 管理存取權 > 作者設定檔,以檢閱新新增的產品設定檔。

Admin Console ​視窗會顯示新新增的產品設定檔。

檢閱新產品設定檔

上述步驟已完成AEM as a Cloud Service環境的現代化。

啟用AEM API存取權 enable-aem-apis-access

新產品設定檔 ​的存在會在Adobe Developer Console (ADC)中啟用OpenAPI型AEM API存取。 回想一下,Adobe Developer Console (ADC)是存取Adobe API、SDK、即時事件、無伺服器函式等的開發人員中心。

新增的產品設定檔與​ 服務 ​相關聯,這些服務代表​ 具有預先定義存取控制清單(ACL) ​的AEM使用者群組。 服務 ​是用來控制AEM API的存取層級。

您也可以選取或取消選取與產品設定檔相關聯的​ 服務,以減少或增加存取層級。

按一下產品設定檔名稱旁的​ 檢視詳細資料 ​圖示,即可檢閱關聯。

檢閱與產品設定檔關聯的服務

依預設,AEM Assets API Users ​服務未與任何產品設定檔建立關聯。 讓我們將其與新新增的​ AEM Assets Collaborator使用者 — 作者 — 方案XXX — 環境XXX ​產品設定檔建立關聯。 建立此關聯後,ADC專案的​ 資產作者API ​可以設定所需的伺服器對伺服器驗證,並將ADC專案(在下一步中建立)的驗證帳戶與產品設定檔建立關聯。

將AEM Assets API使用者服務與產品設定檔建立關聯

IMPORTANT
若要為AEM Assets API啟用伺服器對伺服器驗證,上述步驟至關重要。 若沒有此關聯,AEM Assets API就無法與伺服器對伺服器驗證方法搭配使用。

建立Adobe Developer Console (ADC)專案 adc-project

ADC專案用於新增所需的API、設定其驗證,以及將驗證帳戶與產品設定檔建立關聯。

若要建立ADC專案:

  1. 使用您的Adobe ID登入Adobe Developer Console

    Adobe Developer Console

  2. 在​ 快速入門 ​區段中,按一下​ 建立新專案 ​按鈕。

    建立新專案

  3. 它會以預設名稱建立新專案。

    已建立新專案

  4. 按一下右上角的​ 編輯專案 ​按鈕以編輯專案名稱。 提供有意義的名稱,然後按一下[儲存]。

    編輯專案名稱

設定ADC專案 configure-adc-project

建立ADC專案後,您必須新增所需的AEM API、設定其驗證,並將驗證帳戶與產品設定檔建立關聯。

  1. 若要新增AEM API,請按一下​ 新增API ​按鈕。

    新增API

  2. 在​ 新增API ​對話方塊中,依​ Experience Cloud ​篩選,並選取所需的AEM API。 例如,在此案例中,已選取​ 資產作者API

    新增AEM API

  3. 接下來,在​ 設定API ​對話方塊中,選取所需的驗證選項。 例如,在此案例中,已選取​ 伺服器對伺服器 ​驗證選項。

    選取驗證

    伺服器對伺服器驗證適用於需要API存取而不需使用者互動的後端服務。 「網頁應用程式」和「單頁應用程式」驗證選項適用於需要代表使用者存取API的應用程式。 如需詳細資訊,請參閱 OAuth伺服器對伺服器與Web應用程式與單頁應用程式認證之間的差異

  4. 如有需要,您可以重新命名API以方便識別。 為了示範目的,會使用預設名稱。

    重新命名認證

  5. 在此情況下,驗證方法是​ OAuth伺服器對伺服器,因此您需要將驗證帳戶與產品設定檔建立關聯。 選取​ AEM Assets Collaborator使用者 — 作者 — 方案XXX — 環境XXX ​產品設定檔,然後按一下​ 儲存

    選取產品設定檔

  6. 檢閱AEM API和驗證設定。

    AEM API設定

    驗證組態

如果您選擇​ OAuth網頁應用程式 ​或​ OAuth單頁應用程式 ​驗證方法,將不會提示產品設定檔關聯,但需要應用程式重新導向URI。 應用程式重新導向URI用於在透過授權碼進行驗證後,將使用者重新導向至應用程式。 相關使用案例教學課程會概述此類驗證特定配置。

設定AEM執行個體以啟用ADC專案通訊 configure-aem-instance

若要啟用ADC專案的ClientID以與AEM執行個體通訊,您需要設定AEM執行個體。

方法是在YAML檔案中定義API設定,並使用Cloud Manager中的設定管道進行部署。 YAML檔案會定義來自ADC專案的可與AEM執行個體通訊的允許ClientID。

  1. 在AEM專案中,從config資料夾中找到或建立api.yaml檔案。

    找出API YAML {width="500"}

  2. 將下列設定新增至api.yaml檔案。

    code language-yaml
    kind: "API"
    version: "1.0"
    metadata:
        envTypes: ["dev", "stage", "prod"]
    data:
        allowedClientIDs:
            author:
            - "<ADC Project's Credentials ClientID>"
    

    以ADC專案的認證值的實際ClientID取代<ADC Project's Credentials ClientID>。 此教學課程中使用的API端點僅可在作者層級使用,但對於其他API,yaml設定也可以有​ 發佈 ​或​ 預覽 ​節點。

    note caution
    CAUTION
    為了示範,所有環境都會使用相同的ClientID。 建議您針對每個環境(開發、階段、生產)使用個別的ClientID,以提升安全性和控制能力。
  3. 提交設定變更並將變更推送到Cloud Manager管道所連線的遠端Git存放庫。

  4. 使用Cloud Manager中的設定管道來部署上述變更。 請注意,也可以使用命令列工具將api.yaml檔案安裝在RDE中。

    部署YAML

後續步驟

將AEM執行個體設定為啟用ADC專案通訊後,您就可以開始使用以OpenAPI為基礎的AEM API。 瞭解如何使用不同的OAuth驗證方法以OpenAPI為基礎的AEM API:

使用伺服器對伺服器驗證叫用API

使用伺服器對伺服器驗證啟動API

瞭解如何使用OAuth伺服器對伺服器驗證,從自訂NodeJS應用程式叫用OpenAPI型AEM API。

了解更多

使用網頁應用程式驗證叫用API

使用網頁應用程式驗證啟動API

瞭解如何使用OAuth網頁應用程式驗證,從自訂網頁應用程式叫用OpenAPI型AEM API。

了解更多

使用單頁應用程式驗證叫用API

使用單頁應用程式驗證啟動API

瞭解如何使用OAuth 2.0 PKCE流程,從自訂單頁應用程式(SPA)叫用OpenAPI型AEM API。

了解更多

recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69