開發者 API 與 MCP

您可以透過自己的程式碼或 AI 助理，讀取電子郵件版面配置、寄件者資訊、機密資料、上傳檔案及 HTTP 請求，並管理您的 HTTP 請求和多媒體檔案。Workflow Transactional Email 提供 REST API 及 MCP 伺服器，這兩者皆可在應用程式內的「開發者」頁面進行管理。

所有操作均使用同一組憑證，且兩個介面皆執行相同的規則：您的機密資訊絕不會被讀取，而歷史紀錄在回傳前也會被遮蔽。

簡短版本

基礎網址

text

https://shopify.workflow-transactional-email.app

請使用在「開發者」頁面建立的攜帶者金鑰進行驗證。金鑰以 fak_ 開頭，且僅在建立時顯示一次。

三種存取層級，依序且具累積性：

等級	新增
閱讀	讀取電子郵件版面配置、寄件者、隱藏名稱、上傳檔案、HTTP 請求、瀏覽紀錄及統計資料
讀寫	建立、編輯及刪除 HTTP 請求；刪除未使用的上傳檔案
讀取、寫入與執行	針對其實際目標執行 HTTP 請求

預設情況下發行讀取金鑰。

整理您的媒體檔案

常見用途：找出所有已上傳、但目前已無任何內容引用的標誌或圖片，並將其刪除。

bash

# every file, each flagged with whether a layout or preset still uses it
curl "https://shopify.workflow-transactional-email.app/api/v1/files?usage=true" \
  -H "Authorization: Bearer fak_your_key_here"

# delete one that nothing references
curl -X DELETE "https://shopify.workflow-transactional-email.app/api/v1/files" \
  -H "Authorization: Bearer fak_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"key":"uploads/your-shop.myshopify.com/abc123.png"}'

若某個檔案仍被版面配置或頁首／頁尾預設值所使用，系統會以 409 錯誤碼拒絕該檔案，並標明其使用來源，因此清理腳本便不會意外地破壞正在運行的電子郵件。

第一項請求

確認某個金鑰是否有效，並查看它能做些什麼：

bash

curl https://shopify.workflow-transactional-email.app/api/v1/me \
  -H "Authorization: Bearer fak_your_key_here"

開發者 API 與 MCP

簡短版本

整理您的媒體檔案

第一項請求

延伸閱讀