API per sviluppatori e MCP

Potete visualizzare i layout delle vostre e-mail, i mittenti, i dati riservati, i file caricati e le richieste HTTP sia dal vostro codice che tramite un assistente AI, nonché gestire le vostre richieste HTTP e i file multimediali. Workflow Transactional Email mette a disposizione un’API REST e un server MCP, entrambi gestibili dalla pagina “Developer” all’interno dell’app.

Tutto utilizza un'unica credenziale ed entrambe le piattaforme applicano le stesse regole: le vostre informazioni riservate non sono mai leggibili e la cronologia viene mascherata prima di essere restituita.

La versione breve

URL di base

text

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

Effettuare l’autenticazione utilizzando una chiave “bearer” creata nella pagina “Sviluppatori”. Le chiavi iniziano con fak_ e vengono visualizzate una sola volta, al momento della creazione.

Tre livelli di accesso, ordinati e cumulativi:

Livello	Aggiunge
Leggi	Leggere il layout delle e-mail, i mittenti, i nomi nascosti, i file caricati, le richieste HTTP, la cronologia e le statistiche
Lettura e scrittura	Creare, modificare ed eliminare richieste HTTP; eliminare i file caricati non utilizzati
Lettura, scrittura ed esecuzione	Eseguire una richiesta HTTP indirizzata al suo vero destinatario

Assegnare le chiavi di lettura per impostazione predefinita.

Tramite questa API, le e-mail sono accessibili solo in lettura

Questo è un aspetto che vale la pena conoscere fin dall’inizio. L’invio di e-mail è la funzione principale di questa app, ma l’API non le invia né le modifica.

I layout delle e-mail, i mittenti e le informazioni riservate sono leggibili a tutti i livelli, ma non modificabili da nessun livello. È possibile crearli e modificarli nell’app.
Le richieste HTTP e i file caricati sono gli unici elementi su cui è possibile scrivere.
Non esiste un endpoint per l’invio di e-mail né uno strumento dedicato. Le e-mail vengono inviate quando il workflow Shopify Flow esegue l’azione “Invia e-mail transazionale” e, successivamente, l’API ne registra la traccia nella cronologia.

Pertanto, una chiave di scrittura non può modificare ciò che i vostri clienti ricevono.

Gestione dei Suoi file multimediali

Un utilizzo comune: individuare tutti i loghi o le immagini caricati a cui non fa più riferimento alcun elemento e eliminarli.

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

Un file ancora utilizzato da un layout o da un'impostazione predefinita di intestazione/piè di pagina viene rifiutato con un codice di errore 409 che indica chi lo utilizza, in modo che uno script di pulizia non possa compromettere accidentalmente un’e-mail attiva.

Una prima richiesta

Verifichi che un tasto funzioni e scopra quali operazioni è in grado di eseguire:

bash

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

Approfondimenti

Segreti - come funzionano i segreti all’interno dell’app stessa.
Effettate una richiesta HTTP all'indirizzo Shopify Flow - l'azione HTTP configurata da questi endpoint.
Allegati e immagini - il caricamento e il riutilizzo dei file nell'app.
Cronologia e risoluzione dei problemi - quali dati vengono registrati nella cronologia delle esecuzioni.