API para desarrolladores y MCP

Puede consultar los diseños de sus correos electrónicos, los remitentes, los datos confidenciales, los archivos subidos y las solicitudes HTTP desde su propio código o mediante un asistente de IA, así como gestionar sus solicitudes HTTP y sus archivos multimedia. Workflow Transactional Email ofrece una API REST y un servidor MCP, ambos gestionados desde la página «Desarrollador» dentro de la aplicación.

Todo utiliza una única credencial, y ambas plataformas aplican las mismas normas: sus datos confidenciales nunca son legibles, y el historial se enmascara antes de mostrarse.

La versión resumida

URL base

text

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

Autentíquese con una clave de portador creada en la página de desarrolladores. Las claves comienzan por fak_ y se muestran una sola vez, en el momento de su creación.

Tres niveles de acceso, ordenados y acumulativos:

Nivel	Añade
Leer	Leer diseños de correo electrónico, remitentes, nombres ocultos, archivos adjuntos, solicitudes HTTP, historial y estadísticas
Lectura y escritura	Crear, editar y eliminar solicitudes HTTP; eliminar archivos subidos que ya no se utilicen
Leer, escribir y ejecutar	Realice una solicitud HTTP dirigida a su destino real

Asignar claves de lectura de forma predeterminada.

A través de esta API, el correo electrónico solo se puede consultar.

Esto es lo que conviene saber desde el principio. El envío de correos electrónicos es la función principal de esta aplicación, pero la API no los envía ni los edita.

Las plantillas de correo electrónico, los remitentes y los datos confidenciales son de solo lectura en todos los niveles y no se pueden modificar en ninguno. Créelos y edítelos en la aplicación.
Las solicitudes HTTP y los archivos subidos son los únicos elementos en los que se puede escribir.
No existe ningún punto final para el envío de correo electrónico ni ninguna herramienta de envío de correo electrónico. El correo electrónico se envía cuando su flujo de trabajo de Shopify Flow ejecuta la acción «Enviar correo electrónico transaccional», y la API lo registra posteriormente en el historial.

Por lo tanto, una clave de escritura no puede modificar lo que reciben sus clientes.

Organización de sus archivos multimedia

Un uso habitual: localizar todos los logotipos o imágenes subidos a los que ya no haga referencia ningún elemento y eliminarlos.

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 archivo que aún esté siendo utilizado por un diseño o un preajuste de encabezado/pie de página se rechaza con un código de error 409 en el que se indica qué elemento lo utiliza, de modo que un script de limpieza no pueda dañar accidentalmente un correo electrónico activo.

Una primera solicitud

Compruebe que una tecla funciona y vea qué puede hacer:

bash

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

Lecturas relacionadas

Secretos - cómo funcionan los secretos en la propia aplicación.
Realice una solicitud HTTP desde Shopify Flow - la acción HTTP que configuran estos puntos finales.
Anexos e imágenes - la subida y la reutilización de archivos en la aplicación.
Historial y resolución de problemas - qué datos recoge el historial de ejecuciones.