Workflow Transactional EmailWorkflow Transactional Email

API voor ontwikkelaars en MCP

U kunt uw e-maillay-outs, afzenders van e-mails, geheime gegevens, geüploade bestanden en HTTP-verzoeken inzien via uw eigen code of via een AI-assistent, en uw HTTP-verzoeken en mediabestanden beheren. Workflow Transactional Email biedt een REST-API en een MCP-server, die beide worden beheerd via de pagina ‘Developer’ in de app.

Alles maakt gebruik van één set inloggegevens, en beide platforms hanteren dezelfde regels: uw vertrouwelijke gegevens zijn nooit leesbaar en de geschiedenis wordt gemaskeerd voordat deze wordt weergegeven.

Related articleAuthenticatie en API-sleutelsMaak een sleutel aan, kies het toegangsniveau ervan en begrijp waarom de uitvoeringsbevoegdheid apart wordt behandeld.Related articleREST API-referentieElk eindpunt, het vereiste niveau, queryparameters, statuscodes en verwerkingslimieten.Related articleEen AI-assistent (MCP) koppelenPoint Claude, Cursor, VS Code of Gemini CLI in uw account, met tools die afhankelijk zijn van het sleutelniveau.

De korte versie

Basis-URL

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

Meld u aan met een ‘bearer’-sleutel die op de ontwikkelaarspagina is aangemaakt. Sleutels beginnen met fak_ en worden eenmalig weergegeven bij het aanmaken ervan.

Drie toegangsniveaus, geordend en cumulatief:

Niveau Voegt toe
Lees E-mailopmaak, afzenders, geheime namen, geüploade bestanden, HTTP-verzoeken, geschiedenis en statistieken lezen
Lezen en schrijven HTTP-verzoeken aanmaken, bewerken en verwijderen; ongebruikte geüploade bestanden verwijderen
Lezen, schrijven en uitvoeren Voer een HTTP-verzoek uit naar het daadwerkelijke doel

Geef standaard leessleutels uit.

Het ordenen van uw media

Een veelvoorkomende toepassing: zoek alle geüploade logo’s of afbeeldingen waarnaar nergens meer wordt verwezen, en verwijder deze.

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

Een bestand dat nog steeds door een lay-out of een voorinstelling voor kop- of voettekst wordt gebruikt, wordt geweigerd met een 409-foutmelding waarin wordt aangegeven wat het gebruikt, zodat een opschoningsscript niet per ongeluk een actieve e-mail kan verstoren.

Een eerste verzoek

Controleer of een toets werkt en bekijk wat deze kan doen:

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

Aanbevolen lectuur