OpenAPI ベースの API

最終更新日： 2025年5月15日
  • 適用対象：
  • Experience Manager as a Cloud Service

作成対象：

  • 管理者
  • 開発者

新しいAEM as a Cloud Service API は OpenAPI 仕様に従っているので、一貫性があり、十分にドキュメント化されている API のセットを提供します。

メモ
エンドツーエンドのチュートリアルは、OpenAPI ベースのAEM API を設定して呼び出す方法を学ぶための推奨リソースです。

認証が必要なエンドポイントの場合、認証アプローチはエンドポイントによって異なりますが、OAuth サーバー間、OAuth Web アプリ、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 の設定と呼び出しについて 🔗 エンドツーエンドのチュートリアル を参照してください。 Web アプリとシングルページアプリケーションの認証アプローチについても、同様のチュートリアルが見つかります。

API アクセスの設定

一部の OpenAPI ベースのAEM API には認証が必要で、Adobe Developer Console を使用して資格情報を生成する必要があります。 設定には次の手順が含まれます。

  1. AEM as a Cloud Service環境の最新化。
  2. 製品プロファイルを使用してAEM API へのアクセスを有効にします。 製品プロファイルは、事前定義されたアクセス制御リスト（ACL）を持つAEM ユーザーグループを表すサービスに関連付けられています。 デフォルトでは一部のサービスは特定の製品プロファイルに関連付けられますが、明示的に関連付ける必要があるサービスもあります。例えば、AEM Assets API Users Service は 製品プロファイルに関連付けられていないので、AEM Assets API を使用するには有効にする必要があります。 詳しくは、チュートリアルの手順の AEM API アクセスの有効化を参照してください。
  3. サーバー間認証を追加するには、integration を設定するユーザーが組織のAdobe Admin Console管理者であるか、サービスが関連付けられている製品プロファイルに開発者として追加されている必要があります。 詳しくは、チュートリアルの手順の AEM API アクセスの有効化を参照してください。
  4. Adobe Developer Console（ADC）プロジェクトを作成します。
  5. ADC プロジェクトの設定 これにより、API の呼び出し時にベアラートークンと交換するために後で使用される資格情報が生成されます。
  6. AEM インスタンスを設定して、ADC プロジェクト通信を有効にします。 これには、以下の クライアント ID の登録の節で説明されているように、YAML ファイルを設定してデプロイすることでクライアント ID を環境に登録することが含まれます。

詳細な手順については、OpenAPI ベースの API の設定チュートリアルを参照してください。