OpenAPI を備えた AEM コンテンツフラグメント配信 aem-content-fragment-delivery-with-openapi
Adobe Experience Manager(AEM)as a Cloud Service では、コンテンツフラグメント配信用の AEM OpenAPI には次の特徴があります。
- JSON 形式の AEM コンテンツフラグメントのライブ配信用に最適化された OpenAPI です
- アクティブコンテンツの無効化を可能にする最新の CDN 統合を提供します。
- コンテンツ配信(パフォーマンス、スケーラビリティ、CDN 統合、最適化された JSON 制御と出力)に焦点を合わせています。
- 参照されたフラグメントとアセットの JSON を改善する機能が含まれます。
この API には次の特徴があります。
-
コンテンツフラグメントおよびコンテンツフラグメントモデルの OpenAPI を補完し、コンテンツフラグメントおよびコンテンツフラグメントモデル(CRUD)を管理できます。
-
コンテンツフラグメントと共に使用する AEM GraphQL API の代替となる HTTP REST です。
詳細なドキュメントについて詳しくは、OpenAPI を備えた AEM コンテンツフラグメント配信を参照してください。
- Cloud Service プログラム ID と環境 ID
- コンテンツフラグメント配信 OpenAPI で解決するユースケースの詳細
- アドビが対応する必要のあるすべての連絡先の詳細、およびリクエストやプロジェクトについて情報を保持(必要な場合)
キャッシュ caching
AEM は AEM CDN Fastly と統合されます。つまり、パブリッシュ層で提供される JSON 応答は Fastly レベルでキャッシュされます。
応答は、事前定義されたキャッシュヘッダーに基づいてキャッシュされます(設定できません)。
- 応答は、ブラウザー/クライアントのキャッシュで 5 分間キャッシュされます。
max-age
=300
- 応答は、CDN キャッシュで 1 時間キャッシュされます。
s-maxage
=3600
- 新しいリクエストを再検証している間、最大 1 時間、古いコンテンツが提供される場合があります。
stale-while-revalidate
=3600
- 古いコンテンツは、エラーにより最大 1 日間提供される場合があります。
stale-on-error
=86400
OpenAPI を使用したコンテンツフラグメント配信では、アクティブな CDN キャッシュの無効化をサポートしています。つまり、コンテンツを更新または公開するたびに、対応する JSON OpenAPI 応答は Fastly へのソフトパージリクエストを通じて自動的に無効化されます。これにより、実際の CDN キャッシュの有効期間(s-maxage
)に達する前に、JSON 出力に反映された変更を確認できます。
入手方法 availability
OpenAPI を使用したコンテンツフラグメント配信は、プレビュー層とパブリッシュ層で使用できます。OpenAPI は、プレビューとライブ配信の両方に JSON 形式でコンテンツフラグメントを配信します。
OpenAPI を使用したコンテンツフラグメント配信をプレビューするには、次の操作を行います。
- プレビューへの公開
- IP 許可リストによるプレビューへのアクセスを有効にする
- プレビュー URL の取得
CORS cors
CORS 許可オリジンは、API を呼び出すことができるオリジンを定義します。
Dispatcher 設定側で定義された CORS 許可されたオリジン(特に GraphQL 用)は、この API では考慮されません。
API レート制限 api-rate-limits
この API を使用すると、環境ごとに最大 200 リクエスト/秒のレートで新規リクエストを許可します。
この制限を超えると、API は 429 エラー応答の送信を開始します。これらのエラーはクライアントアプリケーションで処理する必要があり、失敗したリクエストは指数バックオフの再試行後に再試行する必要があります。HTTP 応答には特定のヘッダー Retry-After
が付属しており、リクエストを再度送信するまでどれぐらい待機する必要があるかをクライアントに示します。