AEM API の概要
- トピック:
- 開発
作成対象:
- 初心者
- 開発者
- リーダー
Adobe Experience Manager(AEM)の様々なタイプの API について説明し、統合用に選択する API を理解します。
AEMでコンテンツ、アセット、フォームを作成、読み取り、更新、削除するには、開発者は様々な API を使用できます。 これらの API により、デベロッパーはAEMとやり取りするカスタムアプリケーションを作成できます。
AEMの様々なタイプの API を探索し、統合に選択する API を理解しましょう。
AEM API の種類
AEMは、オーサーサービスとパブリッシュサービスのタイプとやり取りするための次の API を提供します。
詳しくは、Adobe Experience Manager as a Cloud Service API ページを参照してください。
選択する API
統合用の 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 の違い
次に、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 を呼び出す方法を説明します。