1. Cloud development

プレビュー API

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

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

プレビューAPIは、コンテンツのプレビューを表示するGraphQLエンドポイントです。プレビューAPIを使って、まだ承認されていないコンテンツ(ドラフトを含む)にアクセスできます。これは、本番環境に移行する前にステージング環境でコンテンツをテストしたい場合に役立ちます。

!重要本番作業ではDelivery APIを使いましょう。プレビューAPIは大量のトラフィックに対応する容量がありません。

ベースURL

プレビューAPIの基本URLは以下の通りです:

/api/graphql

はContent HubインスタンスURLです。

プレビューIDE

/api/graphql/preview/ide

はContent HubインスタンスURLです。

エンドポイント

プレビューAPIは単一のエンドポイントを公開します:

終着点

HTTP動詞

/api/graphql/preview/v1

POST

ヘッダー

プレビュー APIで 認証 するために使うAPIキーは、Integrated Development Environment (IDE)のHTTP HEADERSタブに追加できます。以下の形式を使い、サンプル値はあなた独自の固有のキーに置き換えてください。

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

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