OpenAPI ベースの API

最終更新日： 2024年11月21日

作成対象：

  • 管理者
  • 開発者
NOTE
OpenAPI は、早期アクセスプログラムの一部として利用できます。 これらにアクセスすることに関心がある場合は、ユースケースの説明を記載した電子メール 🔗0}aem-apis@adobe.com} を送信することをお勧めします。

新しいAEM as a Cloud Service API は OpenAPI 仕様に従っているので、一貫性があり、適切にドキュメント化され、使いやすい API を作成します。 詳しくは、次のページを参照してください。

一般的な API のユースケースは、CRM や PIM などのシステムとの統合に関連しています。AEM API を呼び出してデータを取得または保持します。 Adobe実装の一環として、アプリケーションは AEMが発行するイベントをサブスクライブできます。これにより、統合App Builderまたはその他のインフラストラクチャでビジネスロジックをトリガーにすることができます。

サポートされている API 認証タイプはエンドポイントによって異なりますが、OAuth サーバー間、OAuth Web アプリ、OAuth Single Page App （SPA）の場合があります。

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

API アクセスの設定

多くの OpenAPI ベースのAEM API には認証が必要で、Adobe Developer Console を使用して資格情報を生成する必要があります。 設定には次の手順が含まれます。これらの手順については、このチュートリアルで説明します。

  1. AEM プログラムの 製品プロファイルが更新され目的の API にアクセスするための適切なサービスが有効になっていることを確認します。
  2. Adobe Developer Consoleで新しいプロジェクトを作成し、目的の API をプロジェクトに追加して、適切な認証タイプを選択します。
  3. 資格情報を生成します。これは、後で API を呼び出す際にベアラートークンと交換するために使用されます。
  4. 設定パイプライン（または RDE のコマンドライン）を使用してデプロイされた YAML ファイルを設定して、クライアント ID を環境に登録します。

クライアント ID の登録

クライアント ID は、Adobe Developer Console プロジェクト内のアプリの範囲を特定のAEM環境に限定します。 これを行うには、以下の手順を実行します。

  1. api.yaml または同様の名前を持つファイルを、以下のスニペットのような設定（目的の層（オーサー、パブリッシュ、プレビュー）を含む）で作成します。 値 Client_id、Adobe Developer Console API プロジェクトから取得する必要があります。

    kind、version、metadata のプロパティについては、 設定パイプラインの記事を参照してください。 kind プロパティの値は API に設定し、version プロパティは 1 に設定する必要があります。

    kind: "API"
version: "1"
metadata:
  envTypes: ["dev"]
data:
  allowedClientIDs:
    author:
      - "<client_id>"
    publish:
      - "<client_id>"
    preview:
      - "<client_id>"

  2. 設定パイプラインで説明されているように、ファイルを config または類似の名前の最上位フォルダーの下のどこかに配置します。

  3. コマンドラインツールを使用する RDE 以外の環境タイプの場合は、設定パイプラインの記事の この節で参照されているように、Cloud Managerでターゲット設定パイプラインを作成します。 フルスタックパイプラインと web 階層設定パイプラインでは、設定ファイルをデプロイしません。

  4. 設定をデプロイします。

Experience Manager