Workflow Transactional EmailWorkflow Transactional Email

API para desenvolvedores e MCP

É possível acessar os layouts dos seus e-mails, remetentes, informações confidenciais, arquivos enviados e solicitações HTTP a partir do seu próprio código ou de um assistente de IA, além de gerenciar suas solicitações HTTP e arquivos de mídia. O Workflow Transactional Email disponibiliza uma API REST e um servidor MCP, ambos gerenciados na página “Desenvolvedor” dentro do aplicativo.

Tudo utiliza uma única credencial, e ambas as plataformas aplicam as mesmas regras: seus segredos nunca ficam visíveis, e o histórico é mascarado antes de ser retornado.

Related articleAutenticação e chaves de APICrie uma chave, escolha seu nível de acesso e entenda por que a execução é um aspecto à parte.Related articleReferência da API RESTCada endpoint, o nível necessário, os parâmetros de consulta, os códigos de status e os limites de taxa.Related articleConecte um assistente de IA (MCP)Point Claude, Cursor, VS Code ou Gemini CLI em sua conta, com ferramentas restritas por nível de chave.

A versão resumida

URL base

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

Faça a autenticação com uma chave de portador criada na página do Desenvolvedor. As chaves começam com fak_ e são exibidas uma única vez, no momento da criação.

Três níveis de acesso, ordenados e cumulativos:

Nível Acrescenta
Leia Leia layouts de e-mail, remetentes, nomes secretos, arquivos enviados, solicitações HTTP, histórico e estatísticas
Leitura e gravação Criar, editar e excluir solicitações HTTP; excluir arquivos enviados que não estejam em uso
Ler, gravar e executar Execute uma solicitação HTTP direcionada ao seu destino real

Emitir chaves de leitura por padrão.

Organização de seus arquivos de mídia

Um uso comum: localizar todos os logotipos ou imagens enviados que não sejam mais referenciados por nenhum outro elemento e excluí-los.

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

Um arquivo ainda utilizado por um layout ou por uma predefinição de cabeçalho/rodapé é rejeitado com um código de erro 409, indicando qual elemento o utiliza; assim, um script de limpeza não pode danificar acidentalmente um e-mail ativo.

Um primeiro pedido

Confirme se uma tecla funciona e veja o que ela pode fazer:

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

Leituras relacionadas