Entwickler-API und MCP

Seite kopieren

Nutzen Sie REST-API und MCP-Server von Workflow Transactional Email für Shopify Flow, um HTTP-Anfragen und Absender per Code oder KI zu verwalten.

Sie können Ihre E-Mail-Layouts, E-Mail-Absender, Geheimnisse, hochgeladene Dateien und HTTP-Anfragen über Ihren eigenen Code oder über einen KI-Assistenten abrufen und Ihre HTTP-Anfragen sowie Mediendateien verwalten. Workflow Transactional Email stellt eine REST-API und einen MCP-Server bereit, die beide auf der Entwickler-Seite innerhalb der App verwaltet werden.

Für alles wird ein einziger Zugangsnachweis verwendet, und beide Plattformen wenden dieselben Regeln an: Ihre vertraulichen Daten sind niemals einsehbar, und der Verlauf wird maskiert, bevor er zurückgegeben wird.

Die Kurzfassung

Basis-URL

text

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

Authentifizieren Sie sich mit einem auf der Entwicklerseite erstellten Bearer-Schlüssel. Die Schlüssel beginnen mit fak_ und werden einmalig bei der Erstellung angezeigt.

Drei Zugriffsebenen, geordnet und kumulativ:

Stufe	Fügt hinzu
Lesen	E-Mail-Layouts, Absender, geheime Namen, hochgeladene Dateien, HTTP-Anfragen, Verlauf und Statistiken auslesen
Lesen und Schreiben	HTTP-Anfragen erstellen, bearbeiten und löschen; nicht verwendete hochgeladene Dateien löschen
Lesen, Schreiben und Ausführen	Führen Sie eine HTTP-Anfrage an das eigentliche Ziel aus

Leseschlüssel standardmäßig ausstellen.

E-Mails können über diese API nur gelesen werden

Das sollten Sie gleich zu Beginn wissen: Das Versenden von E-Mails ist die Hauptfunktion dieser App, doch die API versendet diese weder und bearbeitet sie auch nicht.

E-Mail-Layouts, E-Mail-Absender und Geheimnisse sind auf jeder Ebene lesbar, jedoch auf keiner Ebene beschreibbar. Erstellen und bearbeiten Sie diese in der App.
HTTP-Anfragen und hochgeladene Dateien sind die einzigen Elemente, auf die Schreibzugriff besteht.
Es gibt weder einen Endpunkt zum Versenden von E-Mails noch ein Tool zum Versenden von E-Mails. E-Mails werden versendet, wenn Ihr Shopify Flow-Workflow die Aktion „Transaktions-E-Mail senden“ ausführt, und die API protokolliert dies anschließend im Verlauf.

Ein Schreibschlüssel kann also nicht beeinflussen, was Ihre Kunden erhalten.

Verwaltung Ihrer Medien

Eine häufige Anwendung: Suchen Sie alle hochgeladenen Logos oder Bilder, auf die nicht mehr verwiesen wird, und löschen Sie diese.

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"}'

Eine Datei, die noch von einem Layout oder einer Kopf- und Fußzeilenvorlage verwendet wird, wird mit einem 409-Fehler abgelehnt, wobei angegeben wird, wo sie verwendet wird, sodass ein Bereinigungsskript nicht versehentlich eine aktive E-Mail beschädigen kann.

Eine erste Anfrage

Überprüfen Sie, ob eine Taste funktioniert, und sehen Sie, welche Funktionen sie bietet:

bash

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

Weiterführende Literatur

Geheimnisse - wie „Secrets“ in der App selbst funktionieren.
Führen Sie eine HTTP-Anfrage unter Shopify Flow durch - die HTTP-Aktion, die diese Endpunkte konfigurieren.
Anhänge und Bilder - das Hochladen und die Wiederverwendung von Dateien in der App.
Hintergrund und Fehlerbehebung - welche Daten im Ausführungsverlauf erfasst werden.