Experience Edge API
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Experience Edge APIはSitecoreのコンテンツを取得し、Experience Edge環境を管理できるようにします。利用可能なAPIの概要は以下の通りです:
API
概要
コンテンツ管理インスタンスから、未公開および公開済みのSitecoreコンテンツの両方を取得してください。
Experience Edgeから公開されたSitecoreコンテンツのみを取得してください。
Experience Edgeの設定とウェブフックの管理。
トークンのデリバリー GraphQL APIプログラム的に管理できます。
以下のセクションでは、各APIの使用時期について説明します。
Sitecoreコンテンツ取得のためのAPIです
SitecoreAIのコンテンツ作成者は 、ページビルダー を使ってコンテンツの作成、管理、公開を行います。そのコンテンツを取得し、フロントエンドアプリケーションでレンダリングするために、開発者は取得したいコンテンツ量に応じて2つのGraphQL APIのいずれかを使用します。
- プレビュー GraphQL APIを使って、未公開(ドラフト)および公開済みのコンテンツを含むすべてのコンテンツを取得してください。このAPIは通常、ローカル開発やアプリの非本番環境(テストやステージング)で使用されます。これらの環境では、コンテンツ作成者はドラフトをプレビューでき、開発者は公開前にドラフトを含むフロントエンドを構築しテストできます。裏側では、すべてのSitecoreコンテンツがあなたのコンテンツ管理インスタンスに保存されており、このAPIが公開されます。
- 配信GraphQL APIを使って公開コンテンツのみを取得してください。このAPIは、ドラフトコンテンツが利用できないアプリ本格環境で通常使われます。裏側では、公開コンテンツはExperience Edgeから提供されており、このAPIが公開されています。Experience Edgeは、グローバルに分散された高性能なコンテンツ配信レイヤーです。静的でキャッシュされたコンテンツを提供するため、非常に効率的です。
!注プレビュー GraphQL APIはコンテンツ管理インスタンスによって公開されており、Experience Edgeが公開しませんが、Sitecoreコンテンツの取得には両方を使うため、Delivery GraphQL APIと協議されています。
プレビュー GraphQL APIとデリバリー GraphQL APIは異なるコンテンツを返しますが、同じ認可方法を使用し、同じクエリおよびレスポンス形状を共有しています。いくつかの 違いが存在することに注意してください。
両方のGraphQL APIは読み取り専用です。コンテンツの取得と改変の両方を行Sitecoreには、代わりにAuthoring and Management GraphQL APIをご利用ください。
Experience Edgeの管理用API
管理者REST APIを使って、公開されたコンテンツが配信されるExperience Edge環境を管理してください。これらの管理タスクは、コンテンツ管理インスタンスから提供される未公開コンテンツには適用されません。
管理REST APIは主に2つの機能を果たしています。
- Experience Edgeの設定管理 - Experience Edge環境の設定を取得・更新し、公開コンテンツのExperience Edgeキャッシュをすべてクリアし、Experience Edgeから公開コンテンツを削除しますおよびライブタイム(TTL)の更新です。TTLは、コンテンツやメディアアイテムがExperience Edgeキャッシュに保持される最大期間です。
- Manage webhooks - ウェブフックは、公開コンテンツの変更に関する通知を受け取ることを可能にします。例えば、新しいコンテンツがExperience Edgeに公開されるたびに自動的に静的なサイト生成をトリガーするウェブフック通知を設定することができます。
トークン管理のためのAPI
トークンREST APIを使って、プログラム的にデリバリー GraphQL APIトークンを作成、リストアップ、名前変更、取り消すことができます。
配達GraphQL APIにアクセスするのにトークンREST APIを使う必要はありません。代わりに、SitecoreAI Deployで利用可能な認証情報を利用できます。
トークンREST APIはプレビュー GraphQL APIのトークン管理には使えません。