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

Inhaltsverzeichnis

1 Modulübersicht
2 Templates
3 Variablen
- 3.1 $wsOptIn.current
  - 3.1.1 $wsOptIn.current.valid
  - 3.1.2 $wsOptIn.current.token
4 Methoden
- 4.1 $wsOptIn.createTokenUrl()
5 Aktionen
6 Beispiele
- 6.1 Bestätigung der E-Mail-Adresse per Opt-In-Link
7 Weiterführende Links

Modulübersicht

Beispiel / Ausschnitt über $wsOptIn

{{= $wsOptIn | json }}

JSON-Ausgabe

{
  "current": {
    "valid": true,
    "token": "..."
  },
  "createTokenUrl": "ƒ()"
}

Anmerkung: “ƒ()” kennzeichnet eine Funktion.

Variablen und Methoden in der Übersicht:

Variable	Typ	Beschreibung

Variable	Typ	Beschreibung
`current`	map	Gibt eine Map mit Infos zum aktiven Token aus, falls dieser im Request übergeben wurde.
`valid`	bool	Gibt `true` aus, wenn der übergebene Token gültig ist.
`token`	string	Gibt den übergebenen Token als Text aus.
`createTokenUrl()`	string	Erstellt eine Opt-In-URL mit einem sicheren Token.

Templates

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

Variablen

$wsOptIn.current

Enthält Informationen zum Token, der in der aktuellen URL übergeben wurde. Ist null, wenn kein Token in der URL vorhanden ist.

{{ if $wsOptIn.current }}
    // Token wurde übergeben
{{ /if }}

$wsOptIn.current.valid

Gibt true / falseaus, wenn der übergebene Token gültig / ungültig ist.

{{ if $wsOptIn.current.valid }}
    // Token ist gültig
{{ else }}
    // Token ist ungültig oder abgelaufen
{{ /if }}

$wsOptIn.current.token

Gibt den übergebenen Token aus.

Token: {{= $wsOptIn.current.token }}

Methoden

$wsOptIn.createTokenUrl()

Erstellt eine Opt-In-URL mit einem sicheren Token. Der Token wird automatisch generiert und an die angegebene URL angehängt. Diese URL kann dann per E-Mail an den Kunden gesendet werden.

Signatur
$wsOptIn.createTokenUrl(url, tokenName)

Rückgabe
string - URL mit angehängtem Token-Parameter.

Parameter

Name	Typ	Pflicht	Beschreibung

Name	Typ	Pflicht	Beschreibung
`url`	string	ja	Basis-URL, an die der Token angehängt wird.
`tokenName`	string	ja	Name des Tokens. (z.B. `“verifyEmail”`)

Beispiel, das eine URL mit Token für die E-Mail-Verifizierung erstellt.

{{= $wsOptIn.createTokenUrl($wsViews.viewUrl('account/verify.htm'), 'verifyEmail') }}

Aktionen

Für $wsOptIn stehen keine Aktionen zur Verfügung.

Beispiele

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 }}

Weiterführende Links

Aktionen