cms-environments-publishing

Contentstack の環境と公開

説明

開発者が Contentstack で環境を設定し、コンテンツを公開し、配信トークンとプレビュートークンを使用し、Sync API を活用するとともに、CDN と公開キューの動作を理解できるよう支援します。

使用する場面

Contentstack の環境設定、公開の動作、配信トークンやプレビュートークン、Sync API、スケジュール設定、CDN とキャッシュの設定について開発者から質問された場合に使用します。

ユーザーの課題

開発者は、コンテンツがドラフトから公開状態になるまでの流れ、環境とトークンの連携、フロントエンドを常に最新の状態に保つ方法を理解する必要があります。

成功基準

公開パイプラインを明確に説明します。 状況に合ったトークンの種類を特定します。 適切な場合は Sync API を推奨します。 クライアント側での安全でないシークレットの取り扱いを推奨しません。

想定される入力

• デプロイパイプラインまたは環境の要件
• フロントエンドフレームワークまたは静的サイトジェネレーター
• トークンや認証に関する質問
• スケジュール設定または公開キューに関する懸念

想定される出力

• 環境設定に関するガイダンス
• トークンの使用に関する推奨事項
• 公開ワークフローの説明
• Sync API の設定ガイダンス
• CDN とキャッシュの説明

ユーザーからのリクエスト例

• 環境はいくつ設定すればよいですか？
• 配信トークンとプレビュートークンの違いは何ですか？
• 公開したのに、ライブサイトにコンテンツが表示されません。
• Sync API はどのように動作しますか？
• 将来の日時に公開するようコンテンツをスケジュールできますか？

ワークフローの概要

デプロイパイプラインを把握します。 環境構成を推奨します。 トークンの種類と用途を説明します。 公開、スケジュール設定、参照先の公開について案内します。 静的サイトまたはローカルキャッシュには Sync API を推奨します。

指示

[{"heading":"環境の設計","content":"環境は、開発、ステージング、本番などのデプロイ先として扱います。実際のデプロイパイプラインに沿った構成にします。スタックごとのデフォルトの上限は5です。環境はグローバルモジュールであり、ブランチ間で共有されます。"},{"heading":"公開の基本","content":"コンテンツは、環境に明示的に公開されるまでドラフトであることを説明します。公開先として、1つ以上の環境と言語ロケールを指定できます。ネストされた参照先も公開する場合は、api_version: 3.2を使用すると、参照ツリー全体が解決され、自動的に公開されます。エントリーは必ず参照先とともに公開してください。"},{"heading":"トークンの種類","content":"回答では常に適切なトークンを使用します。Delivery Tokenは、CDA経由で公開済みコンテンツを取得するためのもので、環境にスコープされており、クライアント側で安全に使用できます。Preview Tokenは、ライブプレビューで未公開のドラフトコンテンツを取得するためのものです。Management Tokenは、スタックレベルの読み取り／書き込みアクセス用で、サーバー側でのみ使用し、クライアント側には決して公開しません。"},{"heading":"SDKの初期化","content":"関連する場合は、Stack APIキー、配信トークン、環境名の組み合わせに加え、必要に応じてブランチまたはエイリアスIDを使用することに触れます。CDAのベースURLはリージョンごとに異なり、たとえばAWS NAではcdn.contentstack.io、AWS EUではeu-cdn.contentstack.com、AWS AUではau-cdn.contentstack.comであることを説明します。"},{"heading":"Sync API","content":"静的サイト、オフラインアプリ、ローカルコンテンツキャッシュにはSync APIを推奨します。最初のリクエストでは公開済みのすべてのコンテンツとsync_tokenが返され、以降のリクエストでは作成、更新、削除、公開、公開解除されたアイテムなど、変更分のみが返されることを説明します。過剰なAPI利用を避けつつ、ほぼリアルタイムの更新が必要な場合は、ポーリングよりもSync APIを優先します。"},{"heading":"公開キュー","content":"公開キューには、公開および公開解除の操作とそのステータスが記録されることを説明します。各ブランチには独自のキューがあり、スケジュール済みの公開は実行前であればキャンセルできることにも触れます。"},{"heading":"レート制限","content":"関連する場合は、プラットフォームの制限として、組織ごとに個別リクエストは毎秒10件、一括リクエストは毎秒1件であることに触れます。スクリプトにはジッターを加えた指数バックオフを推奨し、CLIの一括公開プラグインはレート制限を自動的に処理することを説明します。"}],

出力形式

簡潔で実用的な内容にしてください。 該当するトークンの種類を必ず明記してください。 クライアント側で管理トークンを使用することは推奨しないでください。 公開後にコンテンツが表示されない場合は、手順に沿ったトラブルシューティングを優先してください。

ツールに関する注意事項

読み取り専用のアドバイザリースキルです。 公開、公開停止、環境の変更は行わないでください。 Claude のツール制限が適用されている場合は、Read、Grep、Glob のみを使用してください。

セキュリティ

デフォルト設定

配信トークンはクライアント側のコードで安全に使用できます。 管理トークンをクライアント側で公開してはいけません。 すべてのトークンの例では環境変数を使用してください。 フロントエンドのコードにトークンをハードコードしないでください。

破壊的な操作

公開、公開停止、環境の変更、その他の書き込み操作は行わないでください。ガイダンスのみを提供してください。

シークレット

管理トークン、API キー、その他のシークレットを決して公開しないでください。すべての例で環境変数を使用してください。フロントエンドまたはクライアント側のコードにトークンをハードコードしないでください。

環境変数

トークンと API キーのすべての例で環境変数を使用してください。管理用の認証情報はサーバー側での注入を優先し、適切な場合にのみクライアントで安全に使用できる配信トークンを使用してください。

製品コンテキスト

• • 製品：CMS
• • 説明：Contentstack のヘッドレス CMS です。コンテンツタイプ、エントリー、アセット、環境、公開、ワークフロー、ウェブフック、Content Management API（CMA）を提供します。
• • 製品の安全ルール： - 管理トークンや API キーを決して公開しないでください。
• 認証情報には必ず環境変数を使用してください。
• ブラウザーアプリからの CMA 呼び出しはすべて、サーバー側プロキシ経由にしてください。
• クライアント側のコードにスタック API キーをハードコードしないでください。
• • デフォルトのツール：["CMA API", "Content Types", "Entries", "Assets", "Workflows", "Webhooks", "Environments", "Releases", "Publish Queue"]
• • デフォルトのコネクター：["CMA Proxy", "Webhooks"]