Utvikler-API og MCP

Utvikler-API og MCP

Kopier side

Les e-postmaler, avsendere og historikk, og administrer HTTP-forespørsler for Shopify Flow via REST-API eller MCP. Hemmeligheter forblir skjult.

Du kan lese e-postmaler, avsendere, hemmelige opplysninger, opplastede filer og HTTP-forespørsler enten via din egen kode eller via en AI-assistent, og administrere HTTP-forespørsler og mediefiler. Workflow Transactional Email stiller til rådighet et REST-API og en MCP-server, som begge administreres på utviklersiden inne i appen.

Alt bruker én påloggingsinformasjon, og begge plattformene håndhever de samme reglene: dine hemmelige opplysninger kan aldri leses, og historikken blir maskert før den returneres.

Related articleAutentisering og API-nøklerOpprett en nøkkel, velg tilgangsnivået for den, og forstå hvorfor «execute» er et eget nivå.Related articleREST API-referanseHvert endepunkt, det nivået det krever, forespørselsparametere, statuskoder og hastighetsbegrensninger.Related articleKoble til en AI-assistent (MCP)Koble Point Claude, Cursor, VS Code eller Gemini CLI til kontoen din, med verktøy som er begrenset etter nøkkelnivå.

Den korte versjonen

Grunn-URL

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

Autentiser deg med en «bearer»-nøkkel som er opprettet på utviklersiden. Nøklene begynner med fak_ og vises én gang, når de opprettes.

Tre tilgangsnivåer, i rekkefølge og kumulativt:

Nivå Legger til
Les Les e-postoppsett, avsendere, hemmelige navn, opplastede filer, HTTP-forespørsler, historikk og statistikk
Les og skriv Opprett, rediger og slett HTTP-forespørsler; slett ubrukte opplastede filer
Les, skriv og kjør Send en HTTP-forespørsel til det egentlige målet

Utsted lesenøkler som standard.

Organisering av mediefilene dine

En vanlig bruksmåte: finn alle opplastede logoer eller bilder som ikke lenger er referert til, og fjern 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 fremdeles brukes av et oppsett eller en forhåndsinnstilling for topp- og bunntekst, avvises med feilkode 409, der det angis hva som bruker den, slik at et ryddeskript ikke ved et uhell kan ødelegge en aktiv e-post.

En første forespørsel

Bekreft at en nøkkel fungerer, og se hva den kan gjøre:

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

Relatert lesestoff