Workflow Transactional EmailWorkflow Transactional Email

Udvikler-API og MCP

Du kan læse dine e-mail-layouts, e-mail-afsendere, hemmeligheder, uploadede filer og HTTP-anmodninger fra din egen kode eller fra en AI-assistent og administrere dine HTTP-anmodninger og mediefiler. Workflow Transactional Email stiller en REST-API og en MCP-server til rådighed, som begge administreres på siden »Developer« inde i appen.

Alt bruger ét sæt legitimationsoplysninger, og begge platforme håndhæver de samme regler: Dine hemmeligheder kan aldrig læses, og historikken maskeres, før den returneres.

Related articleGodkendelse og API-nøglerOpret en nøgle, vælg dens adgangsniveau, og forstå, hvorfor »execute« er en separat kategori.Related articleREST API-referenceHvert eneste endpoint, det krævede niveau, forespørgselsparametre, statuskoder og hastighedsbegrænsninger.Related articleTilslut en AI-assistent (MCP)Point Claude, Cursor, VS Code eller Gemini CLI på din konto, med værktøjer, der er afgrænset efter nøgleniveau.

Den korte version

Basis-URL

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

Log ind med en »bearer key«, der er oprettet på udviklersiden. Nøglerne begynder med fak_ og vises én gang, når de oprettes.

Tre adgangsniveauer, i rækkefølge og kumulativt:

Niveau Tilføjer
Læs Læs e-mail-layouts, afsendere, hemmelige navne, uploadede filer, HTTP-anmodninger, historik og statistik
Læs og skriv Opret, rediger og slet HTTP-anmodninger; slet ubrugte uploadede filer
Læs, skriv og udfør Udfør en HTTP-anmodning mod det egentlige mål

Udsted læsenøgler som standard.

Organisering af dine medier

En almindelig anvendelse: Find alle uploadede logoer eller billeder, som ingen længere henviser til, og slet dem.

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

En fil, der stadig bruges af et layout eller en forudindstilling til sidehoved/sidefod, afvises med en 409-fejl, hvor det angives, hvad der bruger den, så et oprydningsscript ikke ved et uheld kan ødelægge en aktiv e-mail.

En første anmodning

Bekræft, at en nøgle virker, og se, hvad den kan:

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

Yderligere læsning