OpenAPI型AEM API
瞭解OpenAPI型AEM API,包括驗證支援、重要概念,以及如何存取Adobe API。
OpenAPI規格 (先前稱為Swagger)是廣泛使用的RESTful API定義標準。 AEM as a Cloud Service提供數種OpenAPI規格型API (或只是OpenAPI型AEM API),可讓您更輕鬆地建立與AEM的作者或發佈服務型別互動的自訂應用程式。 以下是一些範例:
個網站
- 網站API:使用內容片段的API。
Assets
-
資料夾API:用於處理資料夾的API,例如建立、列出和刪除資料夾。
-
Assets作者API:使用資產及其中繼資料的API。
Forms
- Forms Communications API:處理表單與檔案的API。
在未來版本中,將新增更多以OpenAPI為基礎的AEM API,以支援其他使用案例。
驗證支援 authentication-support
以OpenAPI為基礎的AEM API支援OAuth 2.0驗證,包括下列授權型別:
-
OAuth伺服器對伺服器認證:適用於需要API存取而不需使用者互動的後端服務。 它使用 client_credentials 授權型別,在伺服器層級啟用安全存取管理。 如需詳細資訊,請參閱OAuth伺服器對伺服器認證。
-
OAuth Web App認證:適用於具有代表使用者存取AEM API的前端和 後端 元件的網頁應用程式。 它使用 authorization_code 授權型別,後端伺服器可在此安全地管理密碼和權杖。 如需詳細資訊,請參閱OAuth Web App認證。
-
OAuth Single Page App認證:專為瀏覽器中執行的SPA所設計,需要代表沒有後端伺服器的使用者存取API。 它使用 authorization_code 授權型別,並依賴使用PKCE (代碼交換的證明金鑰)的使用者端安全性機制來保護授權代碼流程。 如需詳細資訊,請參閱OAuth單頁應用程式認證。
OAuth伺服器對伺服器與Web應用程式與單頁應用程式憑證的差異 difference-between-oauth-server-to-server-vs-web-app-vs-single-page-app-credentials
下表總結以OpenAPI為基礎的AEM API所支援的三種OAuth驗證方法之間的差異:
client_id
, client_secret
)。client_id
, client_secret
),以交換存取權杖的授權碼。client_secret
,因為存放在前端App是不安全的。 仰賴PKCE交換存取權杖的授權代碼。存取Adobe API和相關概念 accessing-adobe-apis-and-related-concepts
在存取Adobe API之前,您必須瞭解下列關鍵建構:
-
Adobe Developer Console:存取Adobe API、SDK、即時事件、無伺服器函式等的開發人員中心。 請注意,它不同於用來偵錯AEM應用程式的 AEM Developer Console。
-
Adobe Developer Console專案:管理API整合、事件和執行階段函式的中心位置。 在這裡,您可以設定API、設定驗證並產生所需的認證。
-
產品設定檔:產品設定檔提供許可權預設集,可讓您控制使用者或應用程式對Adobe產品(例如AEM、Adobe Target、Adobe Analytics等)的存取權。 每個Adobe產品都有與其相關聯的預定義產品設定檔。
-
服務:服務會定義實際許可權,並與產品設定檔相關聯。 若要減少或增加許可權預設集,您可以取消選取或選取與產品設定檔關聯的服務。 因此,可讓您控制產品及其API的存取層級。 在AEM as a Cloud Service中,服務代表具有存放庫節點預先定義存取控制清單(ACL)的使用者群組,允許精細的許可權管理。
開始
瞭解如何設定您的AEM as a Cloud Service環境和Adobe Developer Console專案,以啟用OpenAPI型AEM API的存取權。 也可以使用瀏覽器存取AEM API,以驗證設定並檢閱要求和回應。
API教學課程
瞭解如何使用不同的OAuth驗證方法以OpenAPI為基礎的AEM API: