开发者 API 和 MCP

您可以通过自己的代码或 AI 助手读取电子邮件布局、发件人信息、密钥、已上传文件和 HTTP 请求,并管理 HTTP 请求和媒体文件。Workflow Transactional Email 提供了一个 REST API 和一个 MCP 服务器,这两者均可在应用内的**“开发者**”页面中进行管理。

所有操作均使用同一组凭据,且两个界面都执行相同的规则:您的机密信息永远无法被读取,且历史记录在返回前会被屏蔽。

Related article身份验证和 API 密钥创建一个密钥,选择其访问级别,并了解为何“执行”被单独列出。Related articleREST API 参考指南每个端点、其所需的层级、查询参数、状态码和速率限制。Related article连接人工智能助手(MCP)在您的账户中使用 Point Claude、Cursor、VS Code 或 Gemini CLI,相关工具的访问权限受密钥级别限制。

简版

基础网址

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"

相关阅读