基於 OpenAPI 的 API openapi-based-apis
較新的AEM as a Cloud Service API遵循OpenAPI規格，因此提供了一組一致且妥善記錄的API。
對於需要驗證的端點，驗證方法會因端點而異，但可能使用OAuth伺服器對伺服器、OAuth網頁應用程式或OAuth單頁應用程式(SPA)。 認證是透過Adobe Developer Console中的專案設定的。
常見API使用案例涉及與CRM或PIM等系統的整合，此情況下會叫用AEM API來擷取或保留資料。 作為整合實作的一部分，應用程式可能會訂閱AEM發出的事件，這會觸發Adobe App Builder或其他基礎結構中的商業邏輯。
本檔案僅供概覽，以下頁面提供更深入的檔案：
設定API存取 configuring-api-access
有些OpenAPI型AEM API需要驗證，這需要使用Adobe Developer Console產生認證。 設定涉及以下步驟：
- AEM as a Cloud Service環境的現代化。
- 使用產品設定檔啟用對AEM API的存取權。 產品設定檔與代表具有預先定義存取控制清單(ACL)之AEM使用者群組的服務相關聯。 雖然某些服務依預設會與特定產品設定檔建立關聯，但其他服務則需要明確建立關聯；例如，AEM Assets API Users Service未與任何產品設定檔建立關聯，因此您必須啟用它才能使用AEM Assets API。 如需詳細資訊，請參閱啟用AEM API存取教學課程步驟。
- 若要新增伺服器對伺服器驗證，使用者設定整合必須是組織在Adobe Admin Console中的系統管理員，或新增為開發人員至與服務相關聯的產品設定檔。 如需詳細資訊，請參閱啟用AEM API存取教學課程步驟。
- 建立Adobe Developer Console (ADC)專案。
- 設定ADC專案。 這可產生認證，稍後在叫用API時，這些認證將用於交換持有人權杖。
- 設定AEM執行個體以啟用ADC專案通訊。 這涉及透過設定和部署YAML檔案來向環境註冊使用者端ID，如下面的註冊使用者端ID一節所述。
如需詳細的逐步指示，請參閱設定OpenAPI型API教學課程。
註冊使用者端ID registering-a-client-id
使用者端ID會將Adobe Developer Console專案中的API範圍調整至特定的AEM環境。 可透過下列方式達成：
-
使用如下列程式碼片段之類的設定，建立名為
api.yaml或類似的檔案，包括所需的階層（作者、發佈、預覽）。Client_id值應來自您的Adobe Developer Console API專案。kind、version和metadata屬性已在設定管道文章中說明。kind屬性值應該設定為 API，而version屬性應該設定為 1。code language-none kind: "API" version: "1" metadata: envTypes: ["dev"] data: allowedClientIDs: author: - "<client_id>" publish: - "<client_id>" preview: - "<client_id>" -
將檔案放置在名為
config或類似名稱的頂層資料夾之下，如設定管道所述。 -
針對RDE （使用命令列工具）以外的環境型別，在Cloud Manager中建立目標部署設定管道，如設定管道文章中的此區段所參考。 請注意，完整棧疊管道和網頁層管道不會部署設定檔案。
-
部署設定。