logo

Preview API

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/v1POST

ヘッダー

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

名前フォーマット目的
X-GQL-TokenAPI キーToken API を使用して生成された API キー。

リクエスト本文

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

応答形式

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

Can we improve this article ? Provide feedback