サイト連携

サイト連携の設定ガイド

改善案をサイトに反映する方法は、サイトの作り方によって変わります。このページは、自社のサーバーで反映の仕組みを動かす開発担当の方向けです。本番の前に、検証用のサイトとデータで、書き換わる先と公開の状態を確かめてください。

共通の準備

Shopify・Webflow・Contentful・microCMS は、管理画面でトークンを入れるだけでもつなげます。この場合、サーバーの準備は要りません。手順ははじめの設定ガイドの各 CMS のページにあります。

自社サイト API と CMS 下書きジョブを使うには、次の 3 つが必要です。

  • Growth か Pro のご契約が有効であること
  • 対象のサイトで、持ち主の確認が済んでいること(管理画面の「サイトの接続」で行います)
  • オーナーが改善案を承認していること(API キーだけでは、改善案を承認できません)

キーは管理画面の「API」で反映結果を記録できるキーとして発行します。

設定の前に、対象ページの HTTPS の URL と改善項目をそのページに実際に表示される CMS のレコードと項目に、一つずつ対応付けておきます。検証用のデータ、担当者、公開の手順も用意してください。

自社開発サイト

サイト側のサーバーに、改善案 API の仕様に沿った処理を作ります。処理の流れは次のとおりです。承認済みの案を受け取り、URL と項目が許可リストにあるかを照らし合わせます。今の値が変更前と同じときだけ、下書きに保存します。最後に、保存した版と結果を API に返します。

対応する改善項目は title、description、h1、body です。たとえば https://example.com/about の title を自社の「会社概要」レコードのタイトルに対応付けます。公開は、担当者が内容を確かめてから別に行います。

キーの発行から結果の返し方、エラーの一覧までの手順は、画面の写真つきで自社開発のサイトを API でつなぐにあります。キーの保管と、漏れたときの止め方はAPI キーの扱いと安全にあります。

WordPress

管理画面の「サイトの接続」からサイトをつなぎます。WordPress 側で、対象の投稿・固定ページを編集できるユーザーのアプリケーションパスワードを用意します。権限は必要な編集権限だけにし、使わなくなったパスワードは無効にしてください。まずは検証用のページで確かめます。手順はWordPress をつなぐにあります。

WordPress への反映は、公開中のページの内容を直接書き換えます。「この案を使う」などの操作が、書き込みの承認になります。別に下書きを作る方法には対応していません。ページビルダーで作ったページや、編集できない項目などは、文をコピーして手で反映します。

CMS 下書きジョブ

Shopify、Webflow、Contentful、Sanity、microCMS 向けに、サイト側のサーバーで動かす下書きジョブのサンプルがあります。動かすには、Node.js 22.13 以降と、永続ディスク上に置いた非公開の SQLite 台帳が必要です。

CMS の秘密情報は、自社サーバーのシークレットストアから環境変数として渡してください。ブラウザー、設定ファイル、ログには書かないでください。このジョブは、get1pct が CMS の秘密情報を預かって動かすものではありません。

いまは検証用の実装です。5 種類とも、専用の検証環境の未公開コンテンツで、下書きの保存、保存した値の読み直し、再実行したときの結果を実際の環境で確かめています。確かめたのはそれぞれのテストの項目だけです。Shopify で確かめたのは商品名で、SEO の項目は実際の API ではまだ確かめていません。

次の設定例では、URL と get1pct の項目をmicroCMS のエンドポイント、コンテンツ ID、フィールドに対応付けています。値は検証環境に合わせて置き換えてください。

{
  "projectId": "test-project-id",
  "provider": "microcms",
  "options": { "serviceId": "example-sandbox" },
  "targets": [{
    "page": "https://example.com/about",
    "field": "title",
    "target": {
      "endpoint": "draft-fixtures", "id": "about", "field": "title",
      "draftKeyEnv": "MICROCMS_DRAFT_KEY_ABOUT"
    }
  }]
}

共通の環境変数は GET1PCT_API_ORIGIN、GET1PCT_PROJECT_ID、GET1PCT_API_KEY、GET1PCT_CMS_CONFIG、GET1PCT_CMS_JOURNAL です。各 CMS の認証情報は次の変数で指定します。

Shopify

Dev Dashboard でアプリを作り、client credentials の手順でサーバー用のトークンを取得します。検証には、公開しない開発ストアと、未公開(DRAFT)の商品を用意します。

read_products と write_products のスコープを持つトークンを SHOPIFY_INTEGRATION_TOKEN に入れ、shop(例:example.myshopify.com)と productId(例:gid://shopify/Product/123)を指定します。title と description は SEO の項目に、h1 は商品名に当たります。本文は対象外です。

Webflow

検証用のサイトで、CMS の読み取りと書き込みの権限を持つトークンを WEBFLOW_INTEGRATION_TOKEN に入れます。collectionId、itemId、fieldSlug で、主ロケールの編集できる PlainText の項目を指定します。対象のテンプレートが、その項目を表示しているかも確かめてください。変更はステージングに保存され、公開は別の操作です。

Contentful

検証用のスペースと環境で、対象のエントリーを読み取って編集できる管理 API のトークンを CONTENTFUL_INTEGRATION_TOKEN に入れます。spaceId、environmentId、entryId、fieldId、locale(例:ja-JP)を指定します。対象は既存の文字列の項目で、Rich Text は対象外です。公開済みのエントリーを変更した場合も、別に公開するまでは変更がステージングに残ります。

Sanity

検証用のデータセットで、対象の下書きを読み取って編集できるトークンを SANITY_INTEGRATION_TOKEN に入れます。projectId、dataset、すでにある drafts. で始まる documentId、文字列の field を指定します。Portable Text は対象外です。内容は Studio で確かめ、公開するときは別に操作します。

microCMS

検証用のサービスに、リスト形式の API と未公開のコンテンツを用意します。対象の API の GET と PATCH だけを付けたキーを MICROCMS_INTEGRATION_API_KEY に入れます。下書きの draftKey は、設定の draftKeyEnv が指す環境変数に入れます。serviceId、endpoint、id、テキストの field を指定します。対象はすでにある未公開のコンテンツだけです。

テストと運用

  1. 検証用のデータで、URL、項目、変更前の値が一致することを確かめ、承認済みの案を 1 件だけ処理します。
  2. CMS の管理画面で下書きの値と版を確かめ、公開ページが変わっていないことも確かめます。WordPress の直接の反映は、検証用のページで確かめます。
  3. 変更前の値が合わないときや、権限のエラーが出たときは、原因を調べます。保存できたかどうか分からないときは、同じ台帳で再開して値を読み戻します。条件を確かめずに送り直したり、台帳を消したりしないでください。

Shopify、Webflow、microCMS では、保存の直前に値を照らし合わせてから保存するまでの間に、ほかの人が同時に編集するのを完全には防げません。検証のあいだは、同じレコードをほかの人やジョブが編集しないようにしてください。