API para programadores e MCP

Pode consultar os layouts dos seus e-mails, os remetentes, os dados confidenciais, os ficheiros carregados e os pedidos HTTP a partir do seu próprio código ou de um assistente de IA, bem como gerir os seus pedidos HTTP e ficheiros multimédia. O Workflow Transactional Email disponibiliza uma API REST e um servidor MCP, ambos geridos na página «Desenvolvedor» dentro da aplicação.

Tudo utiliza uma única credencial, e ambas as plataformas aplicam as mesmas regras: os seus dados confidenciais nunca são legíveis e o histórico é ocultado antes de ser apresentado.

A versão resumida

URL de base

text

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

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

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

Nível	Acrescenta
Leia	Ler os layouts dos e-mails, os remetentes, os nomes secretos, os ficheiros carregados, os pedidos HTTP, o histórico e as estatísticas
Leitura e escrita	Criar, editar e eliminar pedidos HTTP; eliminar ficheiros carregados que não estejam a ser utilizados
Ler, escrever e executar	Efetue um pedido HTTP para o seu destino real

Emitir chaves de leitura por predefinição.

Através desta API, o e-mail é apenas de leitura

Esta é a informação que convém saber desde o início. O envio de e-mails é a principal função desta aplicação, mas a API não os envia nem os edita.

Os layouts de e-mail, os remetentes de e-mail e os segredos podem ser lidos em todos os níveis, mas não podem ser alterados em nenhum. Crie e edite-os na aplicação.
As solicitações HTTP e os ficheiros carregados são os únicos elementos em que é possível gravar.
Não existe um ponto final para o envio de e-mails nem uma ferramenta para o envio de e-mails. Os e-mails são enviados quando o seu fluxo de trabalho Shopify Flow executa a ação «Enviar e-mail transacional», e a API regista esse facto no histórico posteriormente.

Portanto, uma chave de gravação não pode alterar o que os seus clientes recebem.

Organização dos seus ficheiros multimédia

Uma utilização comum: identificar todos os logótipos ou imagens carregados que já não são referenciados por nada e eliminá-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 ficheiro ainda utilizado por um layout ou por uma predefinição de cabeçalho/rodapé é rejeitado com um erro 409 que indica o que o utiliza, pelo que 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 permite fazer:

bash

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

Leituras relacionadas

Segredos - como funcionam os segredos na própria aplicação.
Efetue um pedido HTTP a partir de Shopify Flow - a ação HTTP que estes pontos finais configuram.
Anexos e imagens - carregar e reutilizar ficheiros na aplicação.
Histórico e resolução de problemas - o que o histórico de execução regista.