Das $wsOptIn Modul erstellt eine Opt-In URL auf Basis einer bestehenden URL indem ein Token-Parameter angehängt wird. Welcher Token angehängt wird, wird durch den Parameter tokenName bestimmt. Welche Tokennamen zur Verfügung stehen, hängt von der ausgeführten Aktion ab und ist bei der jeweiligen Aktion dokumentiert.

Diese URLs werden typischerweise für Bestätigungs- oder Sicherheitsprozesse verwendet, z. B.:

Double-Opt-In für Newsletter-Anmeldungen
E-Mail-Bestätigungen nach Registrierung
Sichere Links für Einladungscodes

Inhaltsübersicht

1 Templates
2 Datenübersicht & Zugriff
3 Beispiele für den Datenzugriff
- 3.1 Bestätigung der E-Mail-Adresse per Opt-In-Link
4 Referenz

Templates

Typischerweise wird das $wsOptIn Modul bei Kontofunktionen wie zum Beispiel beim Passwort-zurücksetzen, oder beim Konto erstellen verwendet.

Datenübersicht & Zugriff

Das $wsOptIn Modul wird primär zum Generieren von Opt-In-URLs verwendet, aber man kann damit auch auf die Daten des Opt-In-Prozesses zugreifen, um z. B. zu überprüfen, ob ein Opt-In erfolgreich war oder ob ein bestimmter Token gültig ist.

<!-- 
	{{= $wsOptIn | json }}
-->

Die Ausgabe in der Developer-Konsole des Browsers könnte dann wie folgt aussehen:

{
  "createTokenUrl": "(Function)",
  "current": {
    "token": "AaqEjiF6NOl_9XNQJr1TEdlfbAfmnwAAAAA.1ds2gN4sOr0DUWr2xjVEvIy5afaljCw8wvcsWRhcFiA",
    "valid": true
  }
}

Create Toke Funktion / Current Valid und Token - wenn man gerade über die URL rein kommt

Beispiele für den Datenzugriff

Bestätigung der E-Mail-Adresse per Opt-In-Link

Nach der Erstellung eines Nutzerkontos im Shop erhält der Nutzer eine E-Mail zur Bestätigung seiner E-Mail-Adresse, z.B.

<a href="{{= $wsOptIn.createTokenUrl($wsViews.viewUrl('account/emailVerify.htm', {}, 'absolute'), 'verifyEmail') }}">
  E-Mail-Adresse bestätigen
</a>

Der Bestätigungslink enthält einen Token, der sicherstellt, dass nur der Empfänger die Bestätigung durchführen kann.

https://www.beispielshop.de/account/emailVerify.htm?token=abc123xyz

Wenn der Nutzer den Link klickt und die Bestätigungsseite (emailVerify.htm) geöffnet wird, wird geprüft, ob der Token gültig ist. Falls ja, kann er die Verifizierung durch einen Button-Click abschließen.

{{ if $wsOptIn.current }}

    {{ if $wsOptIn.current.valid }}
      Button zum Bestätigen
    {{ else }}
      Dieser Link ist nicht länger gültig.
    {{ /if }}
    
{{ else }}

    Ungültiger Zugriff auf die Bestätigungsseite.
    
{{ /if }}

Referenz

In der Modul-Referenz für $wsOptIn finden Sie eine Übersicht aller verfügbaren Eigenschaften und Parameter.