API Modèles d’E-mail

L’API Modèles d’E-mail permet aux administrateurs de personnaliser les e-mails transactionnels envoyés par Auris. Chacun des treize types de modèles correspond à un événement précis (vérification, réinitialisation de mot de passe, magic link, alertes de sécurité, …) et peut être personnalisé avec du HTML et des variables dynamiques, indépendamment pour chaque langue.

Auris fournit des modèles par défaut pour tous les types dans cinq langues (en, it, fr, de, es). Quand un modèle personnalisé existe pour un type et une langue, il est utilisé pour tous les futurs e-mails de ce type ; sinon c’est le défaut avec le branding du tenant qui est utilisé. Ordre de résolution à l’envoi : personnalisé (langue demandée) -> personnalisé (en) -> défaut (langue demandée) -> défaut (en).

Tous les endpoints exigent un jeton Bearer avec la permission manage:security et sélectionnent le tenant via l’en-tête x-tenant (l’identifiant de realm du tenant).

Lister les Modèles

Réponse de succès (200)

{
  "templates": [
    {
      "type": "verification",
      "label": "Email Verification",
      "description": "Sent when a new user registers to verify their email address.",
      "variables": ["email", "link", "expiresIn", "year", "month", "day", "date"],
      "hasCustomTemplate": true,
      "active": true,
      "updatedAt": "2026-07-20T10:00:00.000Z",
      "customLocales": ["en", "fr"]
    }
  ],
  "availableLocales": ["en", "it", "fr", "de", "es"],
  "wellKnownLocales": { "en": "English", "fr": "Français", "pt-BR": "Português (Brasil)" }
}

Récupérer un Modèle

Réponse de succès (200)

{
  "type": "verification",
  "locale": "fr",
  "label": "Email Verification",
  "description": "Sent when a new user registers to verify their email address.",
  "variables": ["email", "link", "expiresIn", "year", "month", "day", "date"],
  "hasCustomTemplate": false,
  "subject": null,
  "htmlBody": null,
  "metadata": null,
  "active": true,
  "updatedAt": null,
  "defaultSubject": "Vérifie ton adresse e-mail",
  "defaultHtmlBody": "<!DOCTYPE html>...",
  "availableLocales": ["en", "it", "fr", "de", "es"],
  "customLocales": ["en"],
  "hasDefaultTemplate": true,
  "wellKnownLocales": { "en": "English", "fr": "Français" }
}

subject, htmlBody et metadata sont null quand aucun modèle personnalisé n’existe pour la langue demandée. defaultSubject et defaultHtmlBody contiennent toujours le modèle intégré, rendu avec le branding du tenant (logo, couleur, footer white-label) exactement comme pour un envoi réel. hasDefaultTemplate indique si la langue demandée a un défaut intégré (en, it, fr, de, es) ; les autres langues retombent sur l’anglais.

Réponses d’erreur

Mettre à Jour un Modèle

Corps de la requête

{
  "subject": "Vérifie ton e-mail — {{email}}",
  "htmlBody": "<!DOCTYPE html><html><body><h1>Vérifie ton e-mail</h1><p>Bonjour {{email}},</p><p><a href=\"{{link}}\">Confirme ton adresse</a></p><p>Le lien expire dans {{expiresIn}}.</p></body></html>",
  "locale": "fr",
  "metadata": { "source": "code" }
}

Le corps HTML est assaini côté serveur avant l’enregistrement : balises <script>, attributs de gestion d’événements (onclick, …), URI javascript:/data:, balises <iframe>/<embed>/<object>/<form>/<base> et constructions CSS dangereuses sont supprimés.

Réponse de succès (200) — l’enregistrement du modèle sauvegardé :

{
  "id": "cltpl123",
  "tenantId": "tnt_ScUtrVKUKGxtu7WY",
  "type": "verification",
  "locale": "fr",
  "subject": "Vérifie ton e-mail — {{email}}",
  "htmlBody": "<!DOCTYPE html>...",
  "metadata": { "source": "code" },
  "active": true,
  "createdAt": "2026-07-23T09:00:00.000Z",
  "updatedAt": "2026-07-23T09:00:00.000Z"
}

Réponses d’erreur

Supprimer un Modèle

Réponse de succès (200)

{ "success": true }

Prévisualiser un Modèle

Corps de la requête

{
  "subject": "Vérifie ton e-mail — {{email}}",
  "htmlBody": "<!DOCTYPE html>..."
}

Réponse de succès (200)

{
  "subject": "Vérifie ton e-mail — [email protected]",
  "html": "<!DOCTYPE html>...",
  "variables": {
    "email": "[email protected]",
    "link": "https://console.auris.dev/verify-email?token=abc123",
    "expiresIn": "24 hours",
    "year": "2026",
    "month": "07",
    "day": "23",
    "date": "2026-07-23"
  }
}

Le champ variables renvoie les valeurs d’exemple substituées. Le corps HTML est assaini avant le rendu ; l’objet est rendu comme texte brut (sans échappement HTML des valeurs).

E-mail de Test

Corps de la requête

{
  "subject": "Vérifie ton e-mail — {{email}}",
  "htmlBody": "<!DOCTYPE html>...",
  "recipientEmail": "[email protected]"
}

Réponse de succès (200)

{ "success": true, "sentTo": "[email protected]" }

Réponses d’erreur

Types de Modèles

Auris supporte treize types de modèles d’e-mail transactionnels :

Les variables de date globales year, month, day et date (format YYYY-MM-DD) sont injectées automatiquement dans chaque rendu, en plus des variables par type listées ci-dessus.

Syntaxe des Modèles

• {{variable}} — remplacée par la valeur. Dans le corps HTML, les valeurs sont échappées automatiquement pour prévenir l’injection ; dans l’objet elles sont insérées comme texte brut.
• {{{variable}}} — interpolation brute sans échappement. Uniquement pour des fragments HTML de confiance construits côté serveur.
• {{#if variable}}...{{/if}} — le bloc est conservé seulement quand la variable a une valeur non vide ; sinon il est supprimé entièrement (markup inclus). Exemple : le modèle par défaut de magic_link n’affiche le bouton d’approbation secondaire que lorsque approveLink est renseigné.

Les placeholders inconnus restent tels quels dans le rendu. La notation pointée et les boucles ne sont pas supportées.

<h1>Connecte-toi à {{tenantName}}</h1>
<p><a href="{{link}}">Se connecter sur cet appareil</a></p>
{{#if approveLink}}
<p><a href="{{approveLink}}">Approuver sur l'appareil d'origine</a></p>
{{/if}}
<p>Le lien expire dans {{expiresIn}}.</p>

Référence des Permissions

Associés

• Personnaliser les Modèles d’E-mail — Guide pas à pas de personnalisation
• Modèles d’E-mail — Modifier les modèles visuellement depuis la Console