整合

網站整合指南

修改如何進入網站,取決於網站的製作方式。請從測試網站和測試資料開始,確認每個修改會寫到哪裡、是否會發布。

不是開發人員嗎?設定指南以截圖說明如何連結 Google 和 WordPress。

共同準備

自建網站 API 與 CMS 草稿工作,需要使用中的 Growth 或 Pro 方案、已確認的網站擁有權,以及擁有者對每個修改的核准。請在 Connections 畫面確認擁有權,再到 API 畫面建立可記錄結果的金鑰。只有 API 金鑰無法核准修改。

請把每個 HTTPS 頁面網址和修改欄位,逐一對應到實際顯示在該頁面的 CMS 記錄與欄位。設定前請準備測試資料、負責人和發布流程。

自建網站

請依照修改 API 規格在網站伺服器上實作處理。取得已核准的修改,以允許清單確認網址和欄位,只有目前的值與「修改前」的值一致時才儲存草稿。再把儲存的版本與結果回報給 API。

支援的修改欄位為 title、description、h1 和 body。例如,把 https://example.com/about 的 title 對應到自家「關於我們」記錄的標題。發布在有人確認後另外進行。

WordPress

在 Connections 畫面連結網站。請為可編輯目標文章和頁面的 WordPress 使用者準備應用程式密碼,並先在測試頁面試用。僅授予必要的編輯權限,並撤銷不再使用的密碼。附截圖的步驟請見連結 WordPress。

套用到已發布的頁面會直接更新公開內容。Use this edit 等操作即為寫入核准。不支援另建草稿。頁面編輯器或無法編輯的欄位,請複製文字手動套用。

CMS 草稿工作

microCMS、Shopify、Webflow、Contentful 和 Sanity 提供在您這邊執行的草稿工作範例。需要 Node.js 22.13 以上,以及放在永久磁碟上的私人 SQLite 日誌。CMS 機密請從自家伺服器的機密儲存以環境變數傳入,切勿放進瀏覽器、設定檔或記錄。Get1pct 不保存您的 CMS 機密,也不代為執行這些工作。

目前是測試用的實作。五種都已在專用測試環境中,以未發布內容於實際環境確認儲存草稿、讀回和重新執行的結果。確認範圍僅限這些測試項目。Shopify 確認了商品名稱,SEO 欄位尚未以實際 API 測試。

下方範例把網址和 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 grant 取得伺服器權杖。請使用不會發布的開發商店和未發布的 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 欄位。請確認範本確實顯示該欄位。變更會儲存在 staging,發布是另外的步驟。

Contentful

在測試空間和環境中,把可讀取並編輯目標項目的管理 API 權杖設在 CONTENTFUL_INTEGRATION_TOKEN。指定 spaceId、environmentId、entryId、fieldId 和 locale(例如 en-US)。支援既有的文字欄位,不支援 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. 以測試資料確認網址、欄位和「修改前」的值一致後,只處理一個已核准的修改。
  2. 在 CMS 管理畫面確認草稿的值和版本,並確認公開頁面沒有改變。WordPress 的直接更新請在測試頁面試用。
  3. 「修改前」的值不一致或權限錯誤時,請查明原因。不確定是否儲存成功時,請以同一份日誌接續並讀回確認。請勿盲目重送或刪除日誌。

使用 microCMS、Shopify 和 Webflow 時,無法完全避免最後確認到儲存之間的同時編輯。測試期間請確保沒有其他人或工作編輯同一筆記錄。