Utvecklings-API och MCP

Kopiera sidan

REST-API och MCP-server för Workflow Transactional Email i Shopify Flow: läs e-postmallar och avsändare, hantera HTTP-förfrågningar med nivåstyrda nycklar.

Du kan läsa av dina e-postmallar, avsändare, hemliga uppgifter, uppladdade filer och HTTP-förfrågningar antingen via din egen kod eller via en AI-assistent, samt hantera dina HTTP-förfrågningar och mediefiler. Workflow Transactional Email tillhandahåller ett REST-API och en MCP-server, som båda hanteras på sidan ”Developer” i appen.

Allt använder en enda autentiseringsuppgift, och båda plattformarna tillämpar samma regler: dina hemliga uppgifter kan aldrig läsas, och historiken maskeras innan den returneras.

Den korta versionen

Bas-URL

text

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

Autentisera dig med en bärarnyckel som skapats på utvecklarsidan. Nycklarna börjar med fak_ och visas endast en gång, när de skapas.

Tre åtkomstnivåer, ordnade och kumulativa:

Nivå	Lägger till
Läs	Läs e-postlayouter, avsändare, hemliga namn, uppladdade filer, HTTP-förfrågningar, historik och statistik
Läs och skriv	Skapa, redigera och ta bort HTTP-förfrågningar; ta bort oanvända uppladdade filer
Läsa, skriva och köra	Skicka en HTTP-förfrågan till dess verkliga mål

Utfärda läsnycklar som standard.

Organisera dina mediefiler

Ett vanligt användningsområde: hitta alla uppladdade logotyper eller bilder som inte längre refereras till, och ta bort 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 som fortfarande används av en layout eller en förinställning för sidhuvud/sidfot avvisas med felkod 409, där det anges vad som använder den, så att ett rensningsskript inte av misstag kan förstöra ett aktivt e-postmeddelande.

En första begäran

Kontrollera att en nyckel fungerar och se vad den kan göra:

bash

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

Relaterad läsning

Hemligheter - hur hemligheter fungerar i själva appen.
Skapa en HTTP-förfrågan från Shopify Flow - den HTTP-åtgärd som dessa slutpunkter konfigurerar.
Bilagor och bilder - ladda upp och återanvända filer i appen.
Historik och felsökning - vad som registreras i körningshistoriken.