E-Mail-Vorlagen-API

Mit der E-Mail-Vorlagen-API können Administratoren die von Auris gesendeten Transaktions-E-Mails anpassen. Jeder der dreizehn Vorlagentypen entspricht einem bestimmten Ereignis (Verifizierung, Passwort-Reset, Magic Link, Sicherheitswarnungen, …) und kann mit HTML und dynamischen Variablen angepasst werden, unabhängig pro Sprache.

Auris liefert Standardvorlagen für alle Typen in fünf Sprachen (en, it, fr, de, es). Existiert eine eigene Vorlage für einen Typ und eine Sprache, wird sie für alle zukünftigen E-Mails dieses Typs verwendet; andernfalls der Standard mit dem Tenant-Branding. Auflösungsreihenfolge beim Versand: eigene Vorlage (angeforderte Sprache) -> eigene Vorlage (en) -> Standard (angeforderte Sprache) -> Standard (en).

Alle Endpunkte erfordern ein Bearer-Token mit der Berechtigung manage:security und wählen den Tenant über den Header x-tenant (die Realm-Kennung des Tenants).

Vorlagen auflisten

Erfolgsantwort (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", "de"]
    }
  ],
  "availableLocales": ["en", "it", "fr", "de", "es"],
  "wellKnownLocales": { "en": "English", "de": "Deutsch", "pt-BR": "Português (Brasil)" }
}

Vorlage abrufen

Erfolgsantwort (200)

{
  "type": "verification",
  "locale": "de",
  "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": "Bestätige deine E-Mail-Adresse",
  "defaultHtmlBody": "<!DOCTYPE html>...",
  "availableLocales": ["en", "it", "fr", "de", "es"],
  "customLocales": ["en"],
  "hasDefaultTemplate": true,
  "wellKnownLocales": { "en": "English", "de": "Deutsch" }
}

subject, htmlBody und metadata sind null, wenn für die angeforderte Sprache keine eigene Vorlage existiert. defaultSubject und defaultHtmlBody enthalten immer die integrierte Vorlage, gerendert mit dem Branding des Tenants (Logo, Farbe, White-Label-Footer) — genau wie bei einem echten Versand. hasDefaultTemplate gibt an, ob die angeforderte Sprache einen integrierten Standard hat (en, it, fr, de, es); andere Sprachen fallen auf Englisch zurück.

Fehlerantworten

Vorlage aktualisieren

Request-Body

{
  "subject": "Bestätige deine E-Mail — {{email}}",
  "htmlBody": "<!DOCTYPE html><html><body><h1>Bestätige deine E-Mail</h1><p>Hallo {{email}},</p><p><a href=\"{{link}}\">Adresse bestätigen</a></p><p>Der Link läuft in {{expiresIn}} ab.</p></body></html>",
  "locale": "de",
  "metadata": { "source": "code" }
}

Der HTML-Inhalt wird vor dem Speichern serverseitig bereinigt: <script>-Tags, Event-Handler-Attribute (onclick, …), javascript:/data:-URIs, <iframe>/<embed>/<object>/<form>/<base>-Tags und gefährliche CSS-Konstrukte werden entfernt.

Erfolgsantwort (200) — der gespeicherte Vorlagendatensatz:

{
  "id": "cltpl123",
  "tenantId": "tnt_ScUtrVKUKGxtu7WY",
  "type": "verification",
  "locale": "de",
  "subject": "Bestätige deine 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"
}

Fehlerantworten

Vorlage löschen

Erfolgsantwort (200)

{ "success": true }

Vorlagenvorschau

Request-Body

{
  "subject": "Bestätige deine E-Mail — {{email}}",
  "htmlBody": "<!DOCTYPE html>..."
}

Erfolgsantwort (200)

{
  "subject": "Bestätige deine 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"
  }
}

Das Feld variables gibt die eingesetzten Beispielwerte zurück. Der HTML-Inhalt wird vor dem Rendern bereinigt; der Betreff wird als reiner Text gerendert (kein HTML-Escaping der Werte).

Test-E-Mail

Request-Body

{
  "subject": "Bestätige deine E-Mail — {{email}}",
  "htmlBody": "<!DOCTYPE html>...",
  "recipientEmail": "[email protected]"
}

Erfolgsantwort (200)

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

Fehlerantworten

Vorlagentypen

Auris unterstützt dreizehn transaktionale E-Mail-Vorlagentypen:

Die globalen Datumsvariablen year, month, day und date (Format YYYY-MM-DD) werden zusätzlich zu den oben aufgeführten typspezifischen Variablen automatisch in jedes Rendering injiziert.

Vorlagensyntax

• {{variable}} — wird durch den Wert ersetzt. Im HTML-Inhalt werden Werte automatisch HTML-escaped, um Injection zu verhindern; im Betreff werden sie als reiner Text eingefügt.
• {{{variable}}} — Raw-Interpolation ohne Escaping. Nur für vertrauenswürdige, serverseitig erzeugte HTML-Fragmente.
• {{#if variable}}...{{/if}} — der Block bleibt nur erhalten, wenn die Variable einen nicht-leeren Wert hat; andernfalls wird er vollständig entfernt (samt Markup). Beispiel: die Standardvorlage von magic_link zeigt den sekundären Bestätigungs-Button nur, wenn approveLink gesetzt ist.

Unbekannte Platzhalter bleiben unverändert in der Ausgabe. Punktnotation und Schleifen werden nicht unterstützt.

<h1>Anmelden bei {{tenantName}}</h1>
<p><a href="{{link}}">Auf diesem Gerät anmelden</a></p>
{{#if approveLink}}
<p><a href="{{approveLink}}">Auf dem Ursprungsgerät bestätigen</a></p>
{{/if}}
<p>Der Link läuft in {{expiresIn}} ab.</p>

Berechtigungsreferenz

Verwandt

• E-Mail-Vorlagen anpassen — Schritt-für-Schritt-Anleitung zur Anpassung
• E-Mail-Vorlagen — Vorlagen visuell in der Konsole bearbeiten