文件AEM as a Cloud Service使用手冊

基於 OpenAPI 的 API

最後更新： 2025年4月17日
  • 主題：
  • 開發

建立對象：

  • 管理員
  • 開發人員

較新的AEM as a Cloud Service API遵循OpenAPI規格，因此提供了一組一致且妥善記錄的API。

NOTE
端對端教學課程是建議的資源，可讓您瞭解如何設定和叫用以OpenAPI為基礎的AEM API。

對於需要驗證的端點，驗證方法會因端點而異，但可能使用OAuth伺服器對伺服器、OAuth網頁應用程式或OAuth單頁應用程式(SPA)。 認證是透過Adobe Developer Console中的專案設定的。

常見API使用案例涉及與CRM或PIM等系統的整合，此情況下會叫用AEM API來擷取或保留資料。 作為整合實作的一部分，應用程式可能會訂閱AEM發出的事件，這會觸發Adobe App Builder或其他基礎結構中的商業邏輯。

本檔案僅供概覽，以下頁面提供更深入的檔案：

  • 來自參考檔案之OpenAPI型API區段的連結。 每個API的參考檔案也包含API遊樂場，這使得使用Adobe Developer Console產生的持有人權杖來試用端點變得容易。

  • 提供資訊的指南，包括API概念和語法。

  • 說明驗證方法和其他概念的最上層教學課程。

  • 此教學課程包含影片，重點說明如何設定OpenAPI型API。

  • 端對端教學課程，說明如何使用伺服器對伺服器驗證策略設定和叫用OpenAPI。 您也可以找到網頁應用程式和單頁應用程式驗證方法的類似教學課程。

設定API存取

有些OpenAPI型AEM API需要驗證，這需要使用Adobe Developer Console產生認證。 設定涉及以下步驟：

  1. AEM as a Cloud Service環境的現代化。
  2. 使用產品設定檔🔗啟用對AEM API 的存取權。
  3. 建立Adobe Developer Console (ADC)專案。
  4. 設定ADC專案。 這可產生認證，稍後在叫用API時，這些認證將用於交換持有人權杖。
  5. 設定AEM執行個體以啟用ADC專案通訊。 這涉及透過設定和部署YAML檔案來向環境註冊使用者端ID，如下面的註冊使用者端ID一節所述。

如需詳細的逐步指示，請參閱設定OpenAPI型API教學課程。

註冊使用者端ID

使用者端ID會將Adobe Developer Console專案中的API範圍調整至特定的AEM環境。 可透過下列方式達成：

  1. 使用如下列程式碼片段之類的設定，建立名為api.yaml或類似的檔案，包括所需的階層（作者、發佈、預覽）。 Client_id值應來自您的Adobe Developer Console API專案。

    kind、version和metadata屬性已在設定管道文章中說明。 kind屬性值應該設定為​ API，而version屬性應該設定為​ 1。

    kind: "API"
version: "1"
metadata:
  envTypes: ["dev"]
data:
  allowedClientIDs:
    author:
      - "<client_id>"
    publish:
      - "<client_id>"
    preview:
      - "<client_id>"

  2. 將檔案放置在名為config或類似名稱的頂層資料夾之下，如設定管道所述。

  3. 針對RDE （使用命令列工具）以外的環境型別，在Cloud Manager中建立目標部署設定管道，如設定管道文章中的此區段所參考。 請注意，完整棧疊管道和網頁層管道不會部署設定檔案。

  4. 部署設定。

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab