Workflow Transactional EmailWorkflow Transactional Email

開発者向けAPIとMCP

ご自身のコードやAIアシスタントから、メールのレイアウト、送信者、シークレット、アップロードされたファイル、HTTPリクエストを確認したり、HTTPリクエストやメディアファイルを管理したりすることができます。Workflow Transactional Emailは、REST APIとMCPサーバーを提供しており、これらはいずれもアプリ内の「**開発者」**ページから管理できます。

すべてが1つの認証情報を使用しており、両方のプラットフォームで同じルールが適用されます。つまり、機密情報は決して読み取られることはなく、履歴は返される前にマスクされます。

Related article認証とAPIキーキーを作成し、そのアクセスレベルを選択し、なぜ「実行」が別扱いになっているのかを理解してください。Related articleREST API リファレンス各エンドポイント、必要なレベル、クエリパラメータ、ステータスコード、およびレート制限。Related articleAIアシスタント（MCP）を接続するご自身のアカウントで、Point Claude、Cursor、VS Code、またはGemini CLIをご利用いただけます。各ツールへのアクセスは、キーのレベルに応じて制限されています。

要約

ベースURL

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

「開発者」ページで作成されたベアラーキーを使用して認証を行ってください。キーは「fak_」で始まり、作成時に一度だけ表示されます。

3つのアクセスレベルは、順序付きかつ累積的です：

レベル 追加
読む メールのレイアウト、送信者、非表示名、アップロードされたファイル、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"

関連記事