b2b - Business-to-Business (B2B) - WEBSALE Dokumentation

Der Knoten b2b enthält die Einstellungen für Shops mit Geschäftskunden. Dazu gehören Zutrittsbeschränkungen, die Einladung von Kunden, die Verwaltung von Mitarbeiterkonten sowie die Verifizierung neuer Konten. Die folgenden Abschnitte beschreiben zunächst die Grundstruktur und anschließend jeden Unterknoten einzeln.

`b2b*` - Grundstruktur

Nachfolgend der Grundaufbau des Knotens b2b:

{
  "b2b": {
    "access": {...},
    "accountVerification": {...},
    "subAccounts": {...},
    "userInvitation": {...}
  }
}

Parameterübersicht

Parameter	Beschreibung
`access`	Steuert die Zutrittsbeschränkungen.
`accountVerification`	Steuert die Verifizierung neuer B2B-Konten.
`subAccounts`	Steuert die Einladungs-E-Mail für neue Mitarbeiterkonten und die Weiterleitung bei gesperrten Seiten.
`userInvitation`	Steuert die Einladungs-E-Mail für Kunden und die Erinnerungs-E-Mail.

`b2b.access` - Zutrittsbeschränkungen

Damit können die Zutrittsbeschränkungen für B2B-Kunden konfiguriert werden, beispielsweise so, dass eine manuelle Freischaltung durch den Händler erforderlich ist, bevor die Registrierung abgeschlossen ist.

Beispielkonfiguration `b2b.access`

{
  "accessBeforeVerification": {
    "allowedTemplates": [
      "account/accountManagement.htm"
    ],
    "allowedUrls": [],
    "redirectTarget": "error.htm",
    "restricted": false
  },
  "allowedActions": [],
  "allowedTemplates": [],
  "allowedUrls": [],
  "redirectTarget": "error.htm",
  "restricted": false
}

Parameterübersicht

Parameter	Typ	Beschreibung
`accessBeforeVerification`	object	Steuert die Zugriffsbeschränkungen für Konten, die noch nicht verifiziert sind. Greift nur, wenn `restricted` auf oberster Ebene aktiv ist.
`accessBeforeVerification.restricted`	bool	Beschränkt für nicht verifizierte Konten den Zugriff auf Seiten (Templates). Erlaubt bleiben nur die Templates aus `allowedTemplates` und das `redirectTarget`. Ob Kategorie- und Produktseiten sichtbar sind, steuert `b2b.accountVerification` über `permissionsBeforeVerification`. Default: false
`accessBeforeVerification.redirectTarget`	string	Name des Templates, auf das ein nicht verifiziertes Konto bei verweigertem Zugriff weitergeleitet wird, beispielsweise `error.htm`. Dieses Template ist immer erlaubt.
`accessBeforeVerification.allowedTemplates`	list (string)	Liste von Templates, die vor der Verifizierung aufgerufen werden dürfen, beispielsweise `account/accountManagement.htm`.
`accessBeforeVerification.allowedUrls`	list (string)	Liste von Pfaden, die vor der Verifizierung immer aufgerufen werden dürfen.
`restricted`	bool	Schaltet die Zutrittsbeschränkungen ein. Nicht angemeldete Besucher können dann nur die Aktionen `Login` und `GuestRegister` sowie die in `allowedActions` freigegebenen Aktionen ausführen. Für angemeldete, noch nicht verifizierte Konten gelten zusätzlich die Einstellungen aus `accessBeforeVerification`. Default: false
`redirectTarget`	string	Name des Templates, auf das der Besucher weitergeleitet wird, wenn er ohne Login auf eine Seite zugreift, die den Login erfordert, beispielsweise `error.htm`.
`allowedTemplates`	list (string)	Liste von Templates, die auch ohne Login aufgerufen werden dürfen.
`allowedUrls`	list (string)	Liste von Pfaden, die auch ohne Login aufgerufen werden dürfen, beispielsweise `/login` oder `/register`.
`allowedActions`	list (string)	Liste von Aktionen, die nicht angemeldete Besucher trotz aktiver Beschränkung ausführen dürfen, beispielsweise `AccountRegister`. `Login` und `GuestRegister` sind immer erlaubt. Bleibt die Liste leer, sind keine weiteren Aktionen freigeschaltet.

`b2b.userInvitation` - Benutzereinladung

Hier wird die E-Mail konfiguriert, mit der ein Kunde eingeladen wird. Die Einladung wird entweder über das Admin-Interface oder über den Endpunkt POST customerAccounts/{accountId}/activate der Admin-Interface-API versendet. Die E-Mail enthält einen Link, über den der Kunde die Einladung mit der Aktion AcceptInvitation annimmt. Im Template erzeugen Sie diesen Link mit dem Token-Namen AcceptInvitation. Optional kann eine Erinnerungs-E-Mail versendet werden, solange die Einladung noch nicht angenommen wurde. Der Einladungslink ist für die in invitationLinkValidityInHours definierte Dauer gültig, mindestens jedoch vier Stunden. Dieselbe Dauer gilt für den Link in der E-Mail zum Zurücksetzen des Passworts (Token-Name passwordReset). Nach Ablauf der Gültigkeitsdauer muss die Einladung erneut versendet werden. Wenn reminderActive: true gesetzt ist, wird eine Erinnerungs-E-Mail an noch offene Einladungen versendet, sobald seit dem Versand der Einladung reminderIntervalInHours Stunden vergangen sind. Jede offene Einladung erhält höchstens eine Erinnerung.

Die Erinnerungs-E-Mail enthält keinen Opt-In-Token. $wsOptIn.createTokenUrl() gibt im Template der Erinnerung deshalb nur die URL ohne Token zurück. Verlinken Sie in der Erinnerung beispielsweise auf eine Seite, auf der der Kunde eine neue Einladung anfordern oder sich an den Shopbetreiber wenden kann.

Beispielkonfiguration b2b.userInvitation

{
  "email": {
    "fromAddress": "",
    "fromName": "",
    "subject": "",
    "template": ""
  },
  "invitationLinkValidityInHours": 24,
  "reminderActive": false,
  "reminderEmail": {
    "fromAddress": "",
    "fromName": "",
    "subject": "",
    "template": ""
  },
  "reminderIntervalInHours": 168
}

Parameterübersicht

Parameter	Typ	Beschreibung
`email`	object	Konfiguration der initialen Einladungs-E-Mail.
`fromAddress`	string	Absenderadresse der E-Mail, beispielsweise `noreply@mein-shop.de`.
`fromName`	string	Anzeigename des Absenders in der E-Mail, beispielsweise „Mein Onlineshop“.
`subject`	string	Betreffzeile der E-Mail, wie sie im Posteingang des Kunden angezeigt wird.
`template`	string	Name oder Pfad der zu verwendenden E-Mail-Vorlage. Darüber werden Inhalt und Layout der E-Mail gesteuert.
`invitationLinkValidityInHours`	int	Gültigkeitsdauer des Einladungslinks in Stunden. Werte unter 4 werden als 4 Stunden behandelt.
`reminderActive`	bool	Aktiviert (`true`) oder deaktiviert (`false`) den automatischen Versand von Erinnerungs-E-Mails an noch nicht angenommene Einladungen.
`reminderEmail`	object	Konfiguration der Erinnerungs-E-Mail. Wird nur genutzt, wenn `reminderActive: true`
`fromAddress`	string	E-Mail-Adresse, von der die Erinnerung gesendet wird.
`fromName`	string	Anzeigename des Absenders der Erinnerungs-E-Mail.
`subject`	string	Betreff der Erinnerungs-E-Mail.
`template`	string	Name oder Pfad der E-Mail-Vorlage für die Erinnerungs-E-Mail.
`reminderIntervalInHours`	int	Anzahl Stunden nach dem Versand der Einladung, nach denen die Erinnerung versendet wird, wenn die Einladung noch nicht angenommen wurde.

`b2b.subAccounts` - Mitarbeiterkonten

Konfiguriert die Einladungs-E-Mail, die ein neuer Mitarbeiter erhält, wenn der Administrator eines Firmenkontos sein Mitarbeiterkonto mit der Aktion SubAccountCreate anlegt. Die E-Mail enthält einen Link, über den der Mitarbeiter mit der Aktion ResetPassword sein Passwort festlegt. Im Template erzeugen Sie diesen Link mit dem Token-Namen ResetPassword (mit großem R). Der Link ist vier Stunden gültig. Mit der Funktion redirectTargetForForbiddenViews wird außerdem festgelegt, wohin ein Mitarbeiterkonto weitergeleitet wird, wenn es eine für seine Berechtigungsgruppe gesperrte Seite aufruft. Beispielkonfiguration b2b.subAccounts

{
  "email": {
    "fromAddress": "",
    "fromName": "",
    "subject": "",
    "template": ""
  },
  "redirectTargetForForbiddenViews": "error.htm"
}

Parameterübersicht

Parameter	Typ	Beschreibung
`email`	object	Konfiguration der Einladungs-E-Mail für neue Mitarbeiterkonten.
`fromAddress`	string	Absenderadresse der E-Mail, beispielsweise `noreply@mein-shop.de`.
`fromName`	string	Anzeigename des Absenders in der E-Mail.
`subject`	string	Betreffzeile der E-Mail.
`template`	string	Name oder Pfad der E-Mail-Vorlage.
`redirectTargetForForbiddenViews`	string	Template, auf das ein Mitarbeiterkonto weitergeleitet wird, wenn es eine gesperrte Seite oder URL aufruft. Dieses Template ist immer erlaubt. Default: `error.htm`

`b2b.accountVerification` - Kontoverifizierung

Konfiguriert den Verifizierungsprozess für B2B-Konten. Mit den Optionen requireEmailVerification und requireManualVerification wird gesteuert, welche Art der Verifizierung erforderlich ist. Mit der Option verificationMerchantEmail werden die E-Mails definiert, die im Rahmen der Freischaltung bzw. beim Widerruf eines Kontos versendet werden. Ist requireManualVerification aktiv, sendet der Shop diese E-Mail an die in toAddress hinterlegte Adresse, sobald ein neues Konto freigeschaltet werden muss. Ist zusätzlich requireEmailVerification aktiv, wird die E-Mail erst nach der Bestätigung der E-Mail-Adresse versendet. Mit permissionsBeforeVerification werden die Berechtigungen festgelegt, die ein noch nicht verifiziertes Konto im Shop hat. Beispielkonfiguration b2b.accountVerification

{
  "requireEmailVerification": true,
  "requireManualVerification": false,
  "verificationMerchantEmail": {
    "fromAddress": "",
    "fromName": "",
    "toAddress": "",
    "subject": "",
    "template": "",
    "subjectForRevocation": "",
    "templateForRevocation": ""
  },
  "permissionsBeforeVerification": {
    "viewProducts": true,
    "viewCategories": true,
    "viewPrices": false,
    "placeOrders": false
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`requireEmailVerification`	bool	Legt fest, ob eine E-Mail-Verifizierung für neue B2B-Konten erforderlich ist.
`requireManualVerification`	bool	Legt fest, ob neue B2B-Konten zusätzlich manuell durch den Händler freigegeben werden müssen.
`verificationMerchantEmail`	object	Konfiguration der E-Mails bei Kontofreischaltung und -widerruf.
`fromAddress`	string	Absenderadresse der E-Mail, beispielsweise `noreply@mein-shop.de`.
`fromName`	string	Anzeigename des Absenders in der E-Mail, beispielsweise „Mein Onlineshop“.
`toAddress`	string	Empfängeradresse für die Benachrichtigung über ein neues Konto, das manuell freigeschaltet werden muss.
`subject`	string	Betreffzeile der E-Mail.
`template`	string	Name oder Pfad der zu verwendenden E-Mail-Vorlage. Darüber werden Inhalt und Layout der E-Mail gesteuert.
`subjectForRevocation`	string	Betreffzeile der E-Mail bei Widerruf der Kontofreischaltung.
`templateForRevocation`	string	Name oder Pfad der zu verwendenden E-Mail-Vorlage für die Widerrufs-E-Mail.
`permissionsBeforeVerification`	object	Definiert, welche Aktionen ein noch nicht verifiziertes Konto im Shop ausführen darf.
`viewProducts`	bool	Legt fest, ob Produkte für nicht verifizierte Konten sichtbar sind.
`viewCategories`	bool	Legt fest, ob Kategorien für nicht verifizierte Konten sichtbar sind.
`viewPrices`	bool	Legt fest, ob Preise für nicht verifizierte Konten sichtbar sind.
`placeOrders`	bool	Legt fest, ob nicht verifizierte Konten Bestellungen aufgeben können. Bei `false` werden auch Warenkorb-Aktionen blockiert.

​b2b* - Grundstruktur

​Parameterübersicht

​b2b.access - Zutrittsbeschränkungen

​Beispielkonfiguration b2b.access

​Parameterübersicht

​b2b.userInvitation - Benutzereinladung

​b2b.subAccounts - Mitarbeiterkonten

​b2b.accountVerification - Kontoverifizierung

`b2b*` - Grundstruktur

Parameterübersicht

`b2b.access` - Zutrittsbeschränkungen

Beispielkonfiguration `b2b.access`

Parameterübersicht

`b2b.userInvitation` - Benutzereinladung

`b2b.subAccounts` - Mitarbeiterkonten

`b2b.accountVerification` - Kontoverifizierung