In diesem Abschnitt werden die verfügbaren Aktionen im Bereich Kundenkonto beschrieben. Mit diesen Aktionen können z.B. Konten erstellt, Adressen verwaltet und Anmeldedaten geändert werden.

Inhaltsverzeichnis

1 Aktionen im Überblick
2 Aktionen
- 2.1 AccountRegister
- 2.2 AccountActivate
- 2.3 AccountActivateOptIn
- 2.4 AccountDelete
- 2.5 AccountDeleteOptIn
- 2.6 SubAccountCreate
- 2.7 AcceptInvitation
- 2.8 UnlockLogin
- 2.9 Login
- 2.10 Logout
- 2.11 PasswordForgotten
- 2.12 ResetPassword
- 2.13 EmailUpdate
- 2.14 EmailUpdateOptIn
- 2.15 EmailVerify
- 2.16 AddressCreate
- 2.17 AddressUpdate
- 2.18 AddressDelete
- 2.19 SetMainAddress
- 2.20 CreditCardDelete
- 2.21 CheckPasswordStrength
- 2.22 accountDisplayNameUpdate
- 2.23 AccountSetCustomerData
- 2.24 GuestRegister
- 2.25 SaveGuestDataToUser

Aktionen im Überblick

Aktion	Beschreibung

Aktion	Beschreibung
`AccountRegister`	Erstellt ein neues Kundenkonto.
`AccountDelete`	Löscht den Account des eingeloggten Benutzers.
`UnlockLogin`	Entsperrt einen gesperrten Login-Zugang.
`Login`	Meldet einen Benutzer an.
`Logout`	Meldet einen eingeloggten Benutzer ab.
`PasswordForgotten`	Sendet eine Passwort-vergessen-E-Mail.
`ResetPassword`	Setzt das Passwort eines Benutzerkontos neu.
`EmailUpdate`	Ändert die hinterlegte E-Mail-Adresse eines Benutzerkontos.
`EmailVerify`	Verifiziert eine E-Mail-Adresse per Double-Opt-In.
`AddressCreate`	Erstellt eine neue Adresse für den eingeloggten Benutzer.
`AddressUpdate`	Bearbeitet eine bestehende Adresse des eingeloggten Benutzers.
`AddressDelete`	Löscht eine Adresse des eingeloggten Benutzers.
`SetMainAddress`	Legt eine Adresse als Hauptadresse fest.
`SaveGuestDataToUser`	Erstellt aus einem Gast-Checkout ein vollwertiges Kundenkonto.

Aktionen

AccountRegister

Mit dieser Aktion wird ein neues Kundenkonto angelegt. Der Benutzer gibt dabei seine E-Mail-Adresse sowie ein Passwort an.

Anwendungsbeispiel
Nutzbar auf einer Registrierungsseite, auf der neue Kunden ein Konto erstellen können, um z.B. ihre Bestellhistorie einzusehen oder Adressen zu verwalten.

Parameter

Name	Beschreibung

Name	Beschreibung
`email`	Identifier des Benutzer-Accounts (standardmäßig die E-Mail-Adresse).
`password`	Passwort des Benutzer-Accounts.
`passwordRepeat`	Erneute Eingabe des Passworts - muss mit `password` übereinstimmen.

Fehlercodes

Code	Beschreibung

Code	Beschreibung
`missingId`	Parameter `id` ist leer.
`missingPassword`	Parameter `password` ist leer.
`passwordMismatch`	Parameter `password` und `passwordRepeat` sind nicht identisch.
`emailCheckFailed`	Parameter `id` enthält eine ungültige E-Mail-Adresse.
`passwordCheckFailed`	Passwort erfüllt nicht die erforderlichen Richtlinien.
`accountAlreadyExists`	Es existiert bereits ein Account mit der angegebenen `id`.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie die Aktion erstellt und in ein Formular eingebunden wird.

{{ var $cActionAccountRegister = $wsActions.create("AccountRegister") }}
<form action="{{= $wsViews.current.url() }}" method="post">
    <input type="hidden" name="wsact" value="{{= $cActionAccountRegister.id }}">
    <input type="hidden" name="wscsrf" value="{{= $cActionAccountRegister.csrf }}">

    <input type="email" name="email">
    <input type="password" name="password">
    <input type="password" name="passwordRepeat">

    <button type="submit">Registrieren</button>
</form>

AccountActivate

Mit dieser Aktion wird ein bestehendes Kundenkonto aktiviert. Die Aktion wird typischerweise über ein Formular ausgelöst.

Anwendungsbeispiel
Nutzbar auf der Bestätigungsseite, auf der der Kunde seine E-Mail-Adresse eingibt, um sein Konto zu aktivieren.

Parameter

Name	Beschreibung

Name	Beschreibung
`id`	Identifier des Benutzer-Accounts (standardmäßig die E-Mail-Adresse).

Fehlercodes

Fehlercode	Beschreibung

Fehlercode	Beschreibung
`missingId`	Parameter `id` ist leer.
`emailCheckFailed`	Parameter `id`enthält eine ungültige E-Mail-Adresse.
`accountAlreadyExists`	Es existiert bereits ein aktiver Account mit der angegebenen `id`.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie die Aktion erstellt und in ein Formular eingebunden wird, über das der Kunde seinen Account mit seiner E-Mail-Adresse aktiviert.

{{ var $cActionAccountActivate = $wsActions.create("AccountActivate") }}
<form action="{{= $wsViews.current.url() }}" method="post">
    <input type="hidden" name="wsact" value="{{= $cActionAccountActivate.id }}">
    <input type="hidden" name="wscsrf" value="{{= $cActionAccountActivate.csrf }}">
    <input type="email" name="id">
    <button type="submit">Account aktivieren</button>
</form>

AccountActivateOptIn

Mit dieser Aktion wird ein bestehendes Kundenkonto per Opt-In-Token aktiviert. Der Token wird dabei über einen Link in einer Bestätigungs-E-Mail an den Benutzer übermittelt.

Anwendungsbeispiel
Nutzbar auf der Bestätigungsseite, auf die der Kunde nach Klick auf den Opt-In-Link in der Registrierungs-E-Mail weitergeleitet wird.

Fehlercodes

Fehlercode	Beschreibung

Fehlercode	Beschreibung
`unauthorized`	Es wurde kein gültiger Opt-In-Token übergeben.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie nach erfolgreicher Ausführung der Aktion eine Bestätigungsmeldung angezeigt wird.

{{ if $wsActions.current.name == "AccountActivateOptIn" and $wsActions.current.success }}
    <div class="alert alert-info">Account wurde aktiviert.</div>
{{ /if }}

AccountDelete

Mit dieser Aktion wird der Account des aktuell eingeloggten Benutzers unwiderruflich gelöscht.

Anwendungsbeispiel
Nutzbar auf einer Account-Verwaltungsseite, auf der eingeloggte Kunden ihr Konto auf Wunsch selbst löschen können.

Fehlercodes

Code	Beschreibung

Code	Beschreibung
notLoggedIn	Der Benutzer ist nicht eingeloggt.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie die Aktion erstellt wird und über einen Bestätigungs-Button ausgelöst wird.

{{ var $cActionAccountDelete = $wsActions.create("AccountDelete") }}
<form action="{{= $wsViews.current.url() }}" method="post">
    <input type="hidden" name="wsact" value="{{= $cActionAccountDelete.id }}">
    <input type="hidden" name="wscsrf" value="{{= $cActionAccountDelete.csrf }}">

    <button type="submit">Account Löschen</button>
</form>

AccountDeleteOptIn

Mit dieser Aktion wird die Löschung eines Kundenkontos per Opt-In-Token bestätigt. Der Token wird über einen Link in einer Bestätigungs-E-Mail an den Benutzer übermittelt.

Anwendungsbeispiel
Nutzbar auf der Bestätigungsseite, auf die der Kunde nach Klick auf den Opt-In-Link in der Löschungs-E-Mail weitergeleitet wird.

Fehlercodes

Fehlercode	Beschreibung

Fehlercode	Beschreibung
`unauthorized`	Es wurde kein gültiger Opt-In-Token übergeben.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie nach erfolgreicher Ausführung der Aktion eine Bestätigungsmeldung angezeigt wird.

{{ if $wsActions.current.name == "AccountDeleteOptIn" and $wsActions.current.success }}
    <div class="alert alert-info">Account wurde gelöscht.</div>
{{ /if }}

SubAccountCreate

Mit dieser Aktion wird ein neues Unterkonto für den eingeloggten Benutzer erstellt.

Anwendungsbeispiel
Nutzbar auf der Account-Verwaltungsseite, auf der eingeloggte Kunden zusätzlich Unterkonten anlegen können.

Parameter

Name	Beschreibung

Name	Beschreibung
`id`	Identifier des neuen Unterkontos (standardmäßig E-Mail-Adresse).
`password`	Passwort des neuen Unterkontos.
`passwordRepeat`	Erneute Eingabe des Passworts - muss mit `password` übereinstimmen.

Fehlercodes

Fehlercode	Beschreibung

Fehlercode	Beschreibung
`notLoggedIn`	Der Benutzer ist nicht eingeloggt.
`missingId`	Parameter `id` ist leer.
`emailCheckFailed`	Parameter `id` enthält eine ungültige E-Mail-Adresse.
`missingPassword`	Parameter `password` ist leer.
`passwordMismatch`	Parameter `password` und `passwordRepeat` sind nicht identisch.
`passwordCheckFailed`	Passwort erfüllt nicht die erforderlichen Richtlinien.
`accountAlreadyExists`	Es existiert bereits ein Account mit der angegebenen `id`.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie die Aktion erstellt und in ein Formular eingebunden wird, über das ein neues Unterkonto angelegt werden kann.

{{ var $cActionSubAccountCreate = $wsActions.create("SubAccountCreate") }}
<form action="{{= $wsViews.current.url() }}" method="post">
    <input type="hidden" name="wsact" value="{{= $cActionSubAccountCreate.id }}">
    <input type="hidden" name="wscsrf" value="{{= $cActionSubAccountCreate.csrf }}">
    <input type="email" name="id">
    <input type="password" name="password">
    <input type="password" name="passwordRepeat">
    <button type="submit">Unterkonto erstellen</button>
</form>

AcceptInvitation

Mit dieser Aktion wird eine Einladung zu einem Kundenkonto angenommen. Der Einladungslink wird per E-Mail an den eingeladenen Benutzer übermittelt.

Anwendungsbeispiel
Nutzbar auf der Bestätigungsseite, auf die der eingeladene Kunde nach Klick auf den Einladungslink in der E-Mail weitergeleitet wird.

Fehlercodes

Fehlercode	Beschreibung

Fehlercode	Beschreibung
`unauthorized`	Es wurde kein gültiger Opt-In-Token übergeben.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie nach erfolgreicher Annahme der Einladung eine Bestätigungsmeldung angezeigt wird.

{{ if $wsActions.current.name == "AcceptInvitation" and $wsActions.current.success }}
    <div class="alert alert-info">Einladung wurde angenommen.</div>
{{ /if }}

UnlockLogin

Mit dieser Aktion wird ein Login-Zugang entsperrt, der aufgrund zu vieler fehlgeschlagener Anmeldeversuche gesperrt wurde. Die Aktion kann sowohl von einem eingeloggten Benutzer als auch über einen Opt-In-Token ausgeführt werden.

Anwendungsbeispiel
Nutzbar, wenn ein Kunde nach mehreren Fehleingaben aus seinem Konto ausgesperrt wurde und einen Entsperrlink per E-Mail erhalten hat.

Fehlercodes

Code	Beschreibung

Code	Beschreibung
`unauthorized`	Der Benutzer ist nicht eingeloggt oder es wurde kein gültiger Opt-In-Token übergeben.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie nach erfolgreicher Ausführung der Aktion eine Bestätigungsmeldung angezeigt wird. Die Aktion selbst wird typischerweise über einen Opt-In-Link in einer E-Mail ausgelöst und benötigt kein Formular.

{{ if $wsActions.current.name == "UnlockLogin" and $wsActions.current.success }}
    <div class="alert alert-info">Account wurde entsperrt</div>
{{ /if }}

Login

Mit dieser Aktion wird ein Benutzer mit seinen Zugangsdaten angemeldet.

Anwendungsbeispiel
Nutzbar auf der Login-Seite, auf der Kunden sich mit E-Mail-Adresse und Passwort in ihr Konto einloggen können.

Parameter

Name	Beschreibung

Name	Beschreibung
`id`	Identifier des Benutzer-Accounts (standardmäßig die E-Mail-Adresse).
`password`	Passwort des Benutzer-Accounts.

Fehlercodes

Code	Beschreibung

Code	Beschreibung
`missingId`	Parameter `id` ist leer.
`missingPassword`	Parameter `password` ist leer.
`emailCheckFailed`	Parameter `id` enthält eine ungültige E-Mail-Adresse.
`loginBlocked`	Zu viele ungültige Loginversuche.
`invalidCredentials`	Ungültiger Loginversuch - `id` oder `password` sind nicht korrekt.

Zugehörige Module, Variablen & Methoden

Beispiel das ein Login-Formular mit E-Mail und Passwort sowie einer allgemeinen Fehlerausgabe bei ungültigen Angaben erstellt.

{{ var $cActionLogin = $wsActions.create("Login") }}
<form action="{{= $wsViews.current.url() }}" method="post">
    <input type="hidden" name="wsact" value="{{= $cActionLogin.id }}">
    <input type="hidden" name="wscsrf" value="{{= $cActionLogin.csrf }}">

    {{ if $cActionLogin.error }}
        <div class="alert alert-danger">Fehler aufgetreten</div>
    {{ /if }}

    <input type="email" name="id" value="{{= $cActionLogin.params.id|ifNull('') }}">
    <input type="password" name="password">

    <button type="submit">Einloggen</button>
</form>

Logout

Mit dieser Aktion wird ein eingeloggter Benutzer abgemeldet.

Anwendungsbeispiel
Nutzbar als Logout-Button im Header oder auf der Account-Übersichtsseite.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie die Aktion über einen einfachen Link ausgelöst wird, der den Benutzer nach dem Logout auf eine definierte Seite weiterleitet.

<a href="{{= $wsActions.url('Logout'
, $wsViews.viewUrl('account/overview.htm'), {}) }}">Ausloggen</a>

PasswordForgotten

Mit dieser Aktion wird eine Passwort-vergessen-E-Mail an die angegebene E-Mail-Adresse gesendet. Die E-Mail enthält einen Opt-In-Link, der die Ausführung der Aktion ResetPassword erlaubt.

Anwendungsbeispiel
Nutzbar auf einer “Passwort vergessen”-Seite, auf der Kunden ihre E-Mail-Adresse eingeben, um einen Wiederherstellungslink zu erhalten.

Parameter

Name	Beschreibung

Name	Beschreibung
`email`	E-Mail-Adresse des Benutzerkontos, an die der Opt-In-Link gesendet wird.

Fehlercodes

Fehlercode	Beschreibung

Fehlercode	Beschreibung
`missingEmail`	Parameter `email` ist leer.
`emailCheckFailed`	Parameter `email` enthält keine gültige E-Mail-Adresse.
`passwordRecoveryFailed`	Es existiert kein Benutzerkonto zu der angegebenen E-Mail-Adresse.

Zugehörige Module, Variablen & Methoden

$wsAccount

Beispiel, das ein Formular erstellt, über das der Kunde seine E-Mail-Adresse eingibt und nach erfolgreicher Ausführung eine Bestätigung erhält.

{{ var $cActionPasswordForgotten = $wsActions.create("PasswordForgotten") }}
<form action="{{= $wsViews.current.url() }}" method="post">
    <input type="hidden" name="wsact" value="{{= $cActionPasswordForgotten.id }}">
    <input type="hidden" name="wscsrf" value="{{= $cActionPasswordForgotten.csrf }}">

    {{ if $cActionPasswordForgotten.success }}
        <div>Passwort erfolgreich zurückgesetzt</div>
    {{ /if }}

    <input type="email" name="email">
    <button type="submit">Neues Passwort anfordern</button>
</form>

ResetPassword

Mit dieser Aktion wird das Passwort eines Benutzerkontos neu gesetzt. Nach erfolgreicher Ausführung wird der Benutzer automatisch ausgeloggt. Standardmäßig gilt die Aktion für den eingeloggten Benutzer - wird ein Opt-In-Token mitgesendet, gilt sie für den mit dem Token verknüpften Benutzer.

Anwendungsbeispiel
Nutzbar auf der Seite, auf die der Kunde über den Passwort-vergessen-Link weitergeleitet wird, um dort ein neues Passwort zu vergeben.

Parameter

Name	Beschreibung

Name	Beschreibung
`newPassword`	Das neue Passwort, das für das Benutzerkonto gesetzt werden soll.
`newPasswordRepeat`	Wiederholung des neuen Passworts zur Vermeidung von Tippfehlern.
`passwordAuth`	Bisheriges Passwort des Benutzerkontos. Nicht erforderlich, wenn ein Opt-In-Token verwendet wird.

Fehlercodes

Fehlercode	Beschreibung

Fehlercode	Beschreibung
`notLoggedIn`	Weder ein Opt-In-Token noch eine eingeloggte Session ist vorhanden.
`missingPassword`	Parameter `newPassword` ist leer.