API pour développeurs et MCP

Copier la page

Pilotez Workflow Transactional Email via une API REST ou un serveur MCP pour vos requêtes HTTP, modèles et expéditeurs, avec secrets jamais lisibles.

Vous pouvez consulter la mise en page de vos e-mails, les expéditeurs, les informations confidentielles, les fichiers mis en ligne et les requêtes HTTP à partir de votre propre code ou d'un assistant IA, et gérer vos requêtes HTTP ainsi que vos fichiers multimédias. Workflow Transactional Email met à disposition une API REST et un serveur MCP, tous deux gérés depuis la page « Développeur » au sein de l'application.

Tout fonctionne avec un seul identifiant, et les deux plateformes appliquent les mêmes règles : vos informations confidentielles ne sont jamais lisibles, et l'historique est masqué avant d'être renvoyé.

La version courte

URL de base

text

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

Connectez-vous à l'aide d'une clé « bearer » créée sur la page « Développeurs ». Les clés commencent par fak_ et ne s'affichent qu'une seule fois, lors de leur création.

Trois niveaux d'accès, hiérarchisés et cumulatifs :

Niveau	Ajoute
Lire	Consulter la mise en page des e-mails, les expéditeurs, les noms d'utilisateur, les fichiers téléchargés, les requêtes HTTP, l'historique et les statistiques
Lecture et écriture	Créer, modifier et supprimer des requêtes HTTP ; supprimer les fichiers téléchargés qui ne sont plus utilisés
Lire, écrire et exécuter	Envoyez une requête HTTP vers sa cible réelle

Émettre des clés de lecture par défaut.

Les e-mails sont en lecture seule via cette API

Voici ce qu'il est important de savoir d'emblée. L'envoi d'e-mails est la fonction principale de cette application, mais l'API ne les envoie pas et ne les modifie pas.

Les mises en page des e-mails, les expéditeurs et les secrets sont lisibles à tous les niveaux, mais ne sont modifiables à aucun niveau. Vous pouvez les créer et les modifier dans l'application.
Les requêtes HTTP et les fichiers téléchargés sont les seuls éléments sur lesquels il est possible d'écrire.
Il **n'**existe ni point de terminaison « send-email », ni outil « send-email ». Les e-mails sont envoyés lorsque votre workflow Shopify Flow exécute l'action « Envoyer un e-mail transactionnel », et l'API l'enregistre ensuite dans l'historique.

Une clé d'écriture ne peut donc pas modifier ce que vos clients reçoivent.

Gestion de vos fichiers multimédias

Une utilisation courante : rechercher tous les logos ou images mis en ligne auxquels plus rien ne fait référence, puis les supprimer.

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 fichier encore utilisé par une mise en page ou un préréglage d'en-tête/pied de page est refusé avec un code d'erreur 409 indiquant l'élément qui l'utilise, ce qui permet d'éviter qu'un script de nettoyage n'endommage accidentellement un e-mail en production.

Une première demande

Vérifiez qu'une touche fonctionne et découvrez ses fonctionnalités :

bash

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

Lectures complémentaires

Secrets - le fonctionnement des secrets au sein même de l'application.
Effectuez une requête HTTP à partir de Shopify Flow - l'action HTTP que ces points de terminaison configurent.
Pièces jointes et images - le téléchargement et la réutilisation de fichiers dans l'application.
Historique et dépannage - ce que contient l'historique des exécutions.