Workflow Transactional EmailWorkflow Transactional Email
Interfejs API dla programistów i MCP

Interfejs API dla programistów i MCP

Skopiuj stronę

Interfejs API REST i serwer MCP aplikacji Workflow Transactional Email dla Shopify Flow: klucze, poziomy dostępu, żądania HTTP i szablony e-mail.

Mogą Państwo odczytywać szablony wiadomości e-mail, dane nadawców, informacje poufne, przesłane pliki oraz żądania HTTP za pomocą własnego kodu lub asystenta AI, a także zarządzać żądaniami HTTP i plikami multimedialnymi. Usługa Workflow Transactional Email udostępnia interfejs API REST oraz serwer MCP, z których oba są zarządzane na stronie Developer w aplikacji.

Wszystkie elementy korzystają z jednego zestawu danych uwierzytelniających, a obie platformy stosują te same zasady: Państwa poufne dane nigdy nie są widoczne, a historia działań jest maskowana przed jej zwrotem.

Related articleUwierzytelnianie i klucze APIProszę utworzyć klucz, wybrać jego poziom dostępu oraz zapoznać się z powodem, dla którego uprawnienie „wykonaj” jest traktowane oddzielnie.Related articleDokumentacja interfejsu API RESTKażdy punkt końcowy, wymagany poziom, parametry zapytania, kody statusu oraz limity częstotliwości.Related articlePodłącz asystenta AI (MCP)Point Claude, Cursor, VS Code lub Gemini CLI na Państwa koncie, z dostępem do narzędzi uzależnionym od poziomu klucza.

W skrócie

Adres URL bazowy

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

Proszę uwierzytelnić się za pomocą klucza typu „bearer”, utworzonego na stronie dla programistów. Klucze zaczynają się od fak_ i są wyświetlane tylko raz, w momencie utworzenia.

Trzy poziomy dostępu, uporządkowane i kumulatywne:

Poziom Dodaje
Przeczytaj Odczytywanie układów wiadomości e-mail, nadawców, ukrytych nazw, przesłanych plików, żądań HTTP, historii i statystyk
Odczyt i zapis Tworzenie, edycja i usuwanie żądań HTTP; usuwanie nieużywanych plików przesłanych na serwer
Odczyt, zapis i wykonanie Proszę wysłać żądanie HTTP do rzeczywistego adresata

Domyślnie należy wydawać klucze odczytu.

Porządkowanie zasobów multimedialnych

Typowe zastosowanie: wyszukanie wszystkich przesłanych logo lub obrazów, do których nie ma już żadnych odwołań, oraz ich usunięcie.

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

Plik, który jest nadal używany przez szablon lub gotowy zestaw nagłówków i stopek, zostanie odrzucony z kodem błędu 409 wraz z informacją o tym, który element go wykorzystuje, dzięki czemu skrypt czyszczący nie może przypadkowo uszkodzić aktywnej wiadomości e-mail.

Pierwsza prośba

Proszę sprawdzić, czy klawisz działa, i zapoznać się z jego funkcjami:

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

Materiały powiązane