Preview API

Version:

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

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

Preview API は、コンテンツのプレビューを表示する GraphQL の API です。最新データのライブアクセスに最適化されています。ドラフトを含む、まだ承認されていないすべてのコンテンツにアクセスするには、Preview API を使用します。Preview API は、コンテンツを本番環境に移行する前のステージング環境でテストする場合に役立ちます。

警告

本番の場合は、Preview API ではなく、Delivery API を使用します。Preview API には、大量のトラフィックを処理する十分なスケールがありません。

ベース URL

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

{ContentHubURL}/api/graphql

ここで、{ContentHubURL} は Content Hub のインスタンス URL です。

IDE

Preview API の IDE の URL は次のとおりです。

{ContentHubURL}/api/graphql/preview/ide

ここで、{ContentHubURL} は Content Hub のインスタンス URL です。

エンドポイント

Preview API は、単一のエンドポイントを公開します。

エンドポイント	HTTP 動詞
`{ContentHubURL}/api/graphql/preview/v1`	`POST`

ヘッダー

Preview API へのすべてのリクエストを API キーで認証する必要があります。

名前	形式	目的
X-GQL-Token	API キー	Token API を使用して生成された API キー。

リクエスト本文

リクエストの本文は GraphQL クエリです。

応答形式

リクエストの応答は GraphQL でフォーマットされた応答です。

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