Workflow Transactional EmailWorkflow Transactional Email

Entwickler-API und MCP

Sie können Ihre E-Mail-Layouts, E-Mail-Absender, Secrets, hochgeladenen Dateien und HTTP-Anfragen aus Ihrem eigenen Code oder von einem KI-Assistenten aus lesen und Ihre HTTP-Anfragen sowie Mediendateien verwalten. Workflow Transactional Email stellt eine REST-API und einen MCP-Server bereit, beide werden auf der Seite Developer innerhalb der App verwaltet.

Alles nutzt einen einzigen Zugangsschlüssel, und beide Schnittstellen setzen dieselben Regeln durch: Ihre Secrets sind nie lesbar, und der Verlauf wird maskiert, bevor er zurückgegeben wird.

Related articleAuthentifizierung und API-SchlüsselErstellen Sie einen Schlüssel, wählen Sie dessen Zugriffsebene und verstehen Sie, warum „execute“ separat ist.Related articleREST-API-ReferenzJeder Endpunkt, die benötigte Ebene, Query-Parameter, Statuscodes und Rate-Limits.Related articleEinen KI-Assistenten verbinden (MCP)Verbinden Sie Claude, Cursor, VS Code oder Gemini CLI mit Ihrem Konto, wobei Tools je nach Schlüsselebene freigeschaltet werden.

Die Kurzfassung

Basis-URL

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

Authentifizieren Sie sich mit einem Bearer-Schlüssel, der auf der Developer-Seite erstellt wurde. Schlüssel beginnen mit fak_ und werden nur einmal, bei der Erstellung, angezeigt.

Drei Zugriffsebenen, geordnet und kumulativ:

Ebene Fügt hinzu
Lesen Lesen von E-Mail-Layouts, Absendern, Secret-Namen, hochgeladenen Dateien, HTTP-Anfragen, Verlauf und Statistiken
Lesen & Schreiben Erstellen, Bearbeiten und Löschen von HTTP-Anfragen; Löschen nicht genutzter hochgeladener Dateien
Lesen, Schreiben & Ausführen Eine HTTP-Anfrage gegen ihr echtes Ziel ausführen

Vergeben Sie standardmäßig Lese-Schlüssel.

Aufräumen Ihrer Medien

Ein häufiger Anwendungsfall: jedes hochgeladene Logo oder Bild finden, auf das nichts mehr verweist, und es entfernen.

bash
# jede Datei, jeweils gekennzeichnet, ob ein Layout oder Preset sie noch verwendet
curl "https://shopify.workflow-transactional-email.app/api/v1/files?usage=true" \
  -H "Authorization: Bearer fak_your_key_here"

# eine Datei löschen, auf die nichts verweist
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"}'

Eine Datei, die noch von einem Layout oder einem Header-/Footer-Preset verwendet wird, wird mit einem 409-Fehler abgelehnt, der benennt, was sie verwendet. So kann ein Cleanup-Skript keine aktive E-Mail versehentlich beschädigen.

Eine erste Anfrage

Bestätigen Sie, dass ein Schlüssel funktioniert, und sehen Sie, was er kann:

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

Weiterführende Themen