AEM API の概要 aem-apis-overview
Adobe Experience Manager(AEM)の様々なタイプの API について学習し、統合用に選択する API を理解します。
AEM でコンテンツ、アセット、フォームを作成、読み取り、更新、削除するために、開発者は様々な API を使用できます。これらの API により、開発者は AEM とやり取りするカスタムアプリケーションを作成できます。
AEM の様々なタイプの API を探索し、統合用に選択する API を理解しましょう。
AEM API のタイプ types-of-aem-apis
AEM は、オーサーサービスとパブリッシュサービスのタイプとやり取りするための次の API を提供します。
詳しくは、Adobe Experience Manager as a Cloud Service API ページを参照してください。
選択する API which-api-to-choose
統合用の API を選択する際には、次の要因を考慮します。
-
ユースケース:AEM API がユースケースをサポートしているかどうかを判断します。可能な限り、AEM とやり取りするための標準化された最新のアプローチを提供する OpenAPI ベースの AEM API を使用 します。OpenAPI ベースの API を利用できない場合は、RESTful API またはGraphQL API を使用し、最後の手段として従来の API を使用することを検討します。
-
互換性:選択した API が AEM のバージョンと互換性があることを確認します。例えば、OpenAPI ベースの AEM API は AEM as a Cloud Service 専用 で、AEM 6.X では使用できません。
-
AEM サービスのタイプ:オーサーとパブリッシュ:アクセスモデルが異なるので、API の選択もオーサーサービスとパブリッシュサービスのどちらで実行されるかによって異なります。AEM オーサーサービスは、コンテンツの作成に使用され、常に認証が必要です。AEM パブリッシュサービスはコンテンツ配信に使用され、ユースケースによっては認証が不要な場合があります。
-
認証:使用する認証方法を API がサポートしていることを確認します。例:
- OpenAPI ベースの AEM API:クライアント資格情報(サーバー間)、認証コード(web アプリ)、コード交換のプルーフキー(単一ページアプリ)付与タイプなど、OAuth 2.0 認証をサポートします。その他の AEM API は、OAuth 2.0 認証をサポートしていません。
- RESTful API:JSON web トークン(JWT)認証をサポートし、トークンベースの認証としても認識されています。
JSON web トークン(JWT)と OAuth 2.0 の違い difference-between-jwt-and-oauth
AEM API で使用される 2 つの一般的な認証メカニズムである、JSON web トークン(JWT)と OAuth 2.0 を比較します。
OpenAPI ベースの AEM API
OpenAPI ベースの AEM API と、Adobe API へのアクセスに関する重要な概念について詳しくは、OpenAPI ベースの AEM API ガイドを参照してください。
ユースケース
OAuth サーバー間認証を使用して、カスタム NodeJS アプリケーションから OpenAPI ベースの AEM API を呼び出す方法を説明します。
OAuth web アプリ認証を使用して、カスタム web アプリケーションから OpenAPI ベースの AEM API を呼び出す方法を説明します。
OAuth 2.0 PKCE フローを使用して、カスタム単一ページアプリ(SPA)から OpenAPI ベースの AEM API を呼び出す方法を説明します。
GraphQL API - 例
GraphQL API とその使用方法について詳しくは、AEM ヘッドレス - GraphQL の概要を参照してください
ユースケース
RESTful API - 例
Assets HTTP API や JSON エクスポーターなどの RESTful API の詳細を説明します。