Headless コンテンツ API

読み取り専用・ETag キャッシュ対応の REST API。

サンプルデータ

サンプルデータで操作の流れを再現しています。右上の ↻ でもう一度再生できます。

構造化フィールド、記事、翻訳、検索をあらゆるフロントエンドに取得。API は読み取り専用で、ETag キャッシュに対応しています。

読み取り専用の設計により、公開コンテンツを安全に外部へ提供できます。書き込み経路は CMS 側のワークフローに限られるため、API から不用意にコンテンツが変更される心配がありません。

ETag キャッシュが変化のないレスポンスの再取得を抑え、配信を高速に保ちます。構造化コンテンツモデルとローカライゼーションをそのまま公開するので、どんなフロントエンドからでも市場ごとの内容を取得できます。

  • 構造化フィールド・記事・翻訳・検索を取得
  • 書き込みを許さない読み取り専用の公開 API
  • 市場・言語ごとの値をそのまま取得
  • ETag キャッシュで高速なレスポンス

使い方

  1. 1フロントエンドから市場とページキーを指定し、公開済みのページフィールドを取得します。
  2. 2translations エンドポイントで、市場とロケールごとの翻訳を取得します。
  3. 3page-articles エンドポイントで、ページに紐付いた記事を取得します。
  4. 4ETag キャッシュを前提に、フロントエンド側の再検証間隔を設定します。

よくある質問

API からコンテンツを書き換えられますか?

いいえ。API は読み取り専用で、変更は CMS のレビューと公開のワークフローからのみ行います。

公開した変更がすぐに反映されないのはなぜですか?

公開 API はキャッシュされているため、再検証が完了するまで少し待つ必要があります。

どの市場のデータを取得できますか?

現在はベトナム(vn)、フィリピン(ph)、インドネシア(id)の市場を指定して取得できます。