actions - Sign-in & registration - WEBSALE Dokumentation

This page contains all actions that relate to the sign-in and registration process in the online shop. Here all messages and email templates are documented that are output when signing in, unlocking an account or resetting a password, etc.

Overview of actions

The actions listed here have been grouped thematically to provide a clear overview of the associated error messages and email templates. Actions that thematically belong to a different area can be found in the corresponding sections of this documentation or in the alphabetical overview of actions.

Excerpt of the basic `actions` structure

{
  "actions": {
    "acceptInvitation": {...},
    "checkPasswordStrength": {...},
    "login": {...},
    "unlockLogin": {...},
    "passwordForgotten": {...},
    "resetPassword": {...}
  }
}

Action overview

Action	Description
`acceptInvitation`	Defines the error messages output when accepting an invitation to a B2B account.
`checkPasswordStrength`	Controls whether the shop checks the strength of a password.
`login`	Defines the error messages output during the sign-in process for a customer account.
`unlockLogin`	Defines the error messages output when lifting a login lock.
`passwordForgotten`	Defines the error messages output during the “password forgotten” process as well as the email that is sent.
`resetPassword`	Defines the error messages output when changing the password.

`actions.acceptInvitation` - Accept invitation (B2B)

The acceptInvitation action controls the error messages that are output when an invited user accepts a B2B account invitation via a double-opt-in link.

Example configuration

{
  "errorCodes": {
    "invalidAccountId": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`invalidAccountId`	string	Error message output when the double-opt-in token cannot be assigned to a customer account.
`actionNotAllowed`	string	Error message output when the double-opt-in token is invalid.

`actions.checkPasswordStrength` - Password strength / password security

The checkPasswordStrength action controls whether the shop system checks the strength of a password on the server side during actions such as registration or password change (e.g. minimum length, complexity).

Example configuration

{
  "active": true
}

Parameter overview

Parameter	Type	Description
`active`	bool	Enables or disables the server-side check of the password strength. Default: `true`

The login action defines which error messages are output during the sign-in process for a customer account.

Example configuration

{
  "errorCodes": {
    "missingId": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "loginBlocked": "<Textbaustein>",
    "invalidCredentials": "<Textbaustein>",
    "ipAddressBlocked": "<Textbaustein>",
    "duplicatePendingReview": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	array	Configures the error codes used for problems during the action.
`missingId`	string	Error message output when no login ID (e.g. email address) was supplied.
`missingPassword`	string	Error message output when no password was supplied.
`emailCheckFailed`	string	Error message output when the supplied email address is considered invalid.
`loginBlocked`	string	Error message output when the user account is temporarily locked.
`invalidCredentials`	string	Error message output when the combination of email address and password is incorrect.
`ipAddressBlocked`	string	Error message output when the current IP address is blocked (blacklist).
`duplicatePendingReview`	string	Error message output when a sign-in is not possible because the account is still undergoing the duplicate check (see accounts.account → `duplicate`).

With the unlockLogin action, you can define error messages that are output when lifting a login lock for a customer account.

Example configuration

{
  "errorCodes": {
    "unauthorized": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`unauthorized`	string	Error message output when the unlock is not allowed (e.g. invalid link or missing permission).

`actions.passwordForgotten` - Password forgotten

With the passwordForgotten action, you define the error messages that are shown during the “password forgotten” process.

Example configuration

{
  "email": {
    "template": "password_forgotten.htm",
    "subject": "Passwort zurücksetzen",
    "fromAddress": "noreply@meinshop.de",
    "fromName": "Mein Onlineshop"
  },
  "errorCodes": {
    "missingEmail": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "passwordRecoveryFailed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`email`	object	Configures the email that is sent when resetting the password. Subject, sender and template are controlled via the general email parameters, see here: Email settings
`errorCodes`	object	Configures the error codes used for problems during the action.
`missingEmail`	string	Error message output when no email address was supplied.
`emailCheckFailed`	string	Error message output when the supplied email address is considered invalid.
`passwordRecoveryFailed`	string	Error message output when the password reset fails.

`actions.resetPassword` - Reset password

The resetPassword action defines which error messages are output when changing the password for an existing customer account and which checks/actions are performed.

Example configuration

{
  "autoLogout": true,
  "checkOldPassword": true,
  "checkLoginID": false,
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "emailMismatch": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>",
    "missingPasswordAuth": "<Textbaustein>",
    "failedPasswordAuth": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`autoLogout`	bool	Sets whether the customer is automatically signed out after a successful password change. Default: `true`
`checkOldPassword`	bool	Indicates whether the previous password should additionally be requested and checked when changing the password. Default: `true`
`checkLoginID`	bool	If `true`, it is additionally checked whether the supplied login ID/email matches the account. Default: `false`
`errorCodes`	object	Configures the error codes used for problems during the action.
`notLoggedIn`	string	Error message output when the user is not signed in.
`missingEmail`	string	Error message output when no email address was supplied.
`emailMismatch`	string	Error message output when the old email address was not supplied correctly.
`missingPassword`	string	Error message output when no password was supplied.
`passwordMismatch`	string	Error message output when the password and password confirmation do not match.
`missingPasswordAuth`	string	Error message output when the current password is required as confirmation but was not supplied.
`failedPasswordAuth`	string	Error message output when the entered current password is not correct.
`passwordCheckFailed`	string	Error message output when the password does not meet the minimum requirements.

​Overview of actions

​Excerpt of the basic actions structure

​Action overview

​actions.acceptInvitation - Accept invitation (B2B)

​Example configuration

​Parameter overview

​actions.checkPasswordStrength - Password strength / password security

​Example configuration

​Parameter overview

​actions.login - Sign-in

​Example configuration

​Parameter overview

​actions.unlockLogin - Unlock sign-in

​Example configuration

​Parameter overview

​actions.passwordForgotten - Password forgotten

​Example configuration

​Parameter overview

​actions.resetPassword - Reset password

​Example configuration

​Parameter overview

Overview of actions

Excerpt of the basic `actions` structure

Action overview

`actions.acceptInvitation` - Accept invitation (B2B)

Example configuration

Parameter overview

`actions.checkPasswordStrength` - Password strength / password security

Example configuration

Parameter overview

`actions.login` - Sign-in

Example configuration

Parameter overview

`actions.unlockLogin` - Unlock sign-in

Example configuration

Parameter overview

`actions.passwordForgotten` - Password forgotten

Example configuration

Parameter overview

`actions.resetPassword` - Reset password

Example configuration

Parameter overview