プレビュー API

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

プレビュー APIは、コンテンツのプレビューを公開するGraphQLエンドポイントです。Preview APIを使用して、ドラフトなど、まだ承認されていないコンテンツにアクセスします。これは、本番環境に移行する前にステージング環境でコンテンツをテストする場合に便利です。

大事な

本番環境の作業には、Delivery APIを使用します。Preview APIには、大量のトラフィックに対応する容量がありません。

ベースURL

Preview APIのベースURLは次のとおりです。

<ContentHubURL>/api/graphql

ここで、<ContentHubURL> はContent HubインスタンスURLです。

<ContentHubURL>/api/graphql/preview/ide

ここで、<ContentHubURL> はContent HubインスタンスURLです。

Preview APIは1つのエンドポイントを公開します。

エンドポイント	HTTP動詞
{:placeholder-token:}<ContentHubURL>{/:placeholder-token:}/api/graphql/preview/v1	POST

プレビュー APIでの認証に使用するAPIキーは、Integrated Development Environment (IDE)のHTTP HEADERSタブに追加できます。次の形式を使用しますが、サンプル値を独自の一意のキーに置き換えてください。

{
  "X-GQL-Token":"aEtSNzBsTaEtSNzBMA"
}

この記事を改善するための提案がある場合は、お知らせください!