Installationsanleitung für Magento2

Endereco Address Management Service Modul (AMS)
Für Magento 2.2.x – 2.4.x

Release Notes:

Aktuelle Release Notes findest du ganz bequem auf unserer Github Seite:

Release Notes zur aktuellen Version 1.2.0

Änderungen in dieser Version:
  • Added support for JavaScript-debugging
  • Added support for separate request/response-logging
  • Renamed “Base URL” to “API Endpoint” in configuration
  • Fixed house number bug. An empty house number was taken as string “null” in the selected address
  • Fixed city bug – city was not provided to API for address book entries
  • Added eMail check – at the moment it will display only warnings, no hard bounces yet

RELEASE-NEWSLETTER

Trage dich in unseren Release-Newsletter ein, dann wirst du bei einem Update immer schnell informiert. 

Funktionsbeschreibung

Die Endereco Address Management Services (AMS) ermöglichen auf einfache und unkomplizierte Weise, die Qualität der Adressdaten, die von deinen Kunden eingegeben werden, zu verbessern. Falsche Adressen können von den Kunden durch Korrekturvorschläge direkt korrigiert werden. Die Schreibweise von Adressen wird normiert . Hierfür wird ein zweistufiger Prozess in die Adressformulare integriert, der eine korrekte Erfassung der Daten über nahezu alle Eingabegeräte sicherstellt.

Schritt 1 – direkt während der Eingabe

a) Adresseingabe-Assistent (In Entwicklung)

Vorschläge zu eingegebenen Adressfragmenten werden in einer Autocomplete Funktion von Straße, PLZ und Ort angezeigt. Dies funktioniert auf PCs, Tablets und Smartphones. Die Adresseingabe wird vereinfacht, beschleunigt und die Fehlerquote massiv reduziert.

b) Anredeprüfung (In Entwicklung)

Die Endereco Vornamendatenbank mit über 30.000 Einträgen kann geschlechtsspezifisch eindeutige Vornamen erkennen, und markiert das entsprechende Anredefeld ihres Webshops. Mehrdeutige oder unbekannte Namen werden ignoriert. Groß- und Kleinschreibung wird automatisch korrigiert.

c) Validierung der E-Mail Adresse

Eine eingegebene E-Mail-Adresse wird in Echtzeit auf verschiedene Merkmale geprüft:

  • Gültige Syntax der E-Mail-Adresse
  • Gültige Länderdomain
  • Ist das E-Mail Postfach registriert und erreichbar?
  • Ist das Postfach voll oder zustellbar?
  • Handelt es sich um eine Einweg-Adresse oder SPAM E-Mail-Adresse?

Schritt 2 – beim Absenden des Formulars

a) AddressCheck

Der Adresscheck validiert eingegebenen Adressfelder auf Gültigkeit im Gesamtzusammenhang. Für nicht plausible Eingaben werden automatisch valide Korrekturverschläge angeboten. Der Kunde kann zwischen seiner Eingabe und einem der Korrekturverschläge wählen.

DemoShop


Installationsanleitung

2.1 Neuinstallation des Moduls

Die Installation kann manuell oder über den Composer erfolgen

Option 1 – Manuelle Installation:

Lade den aktuellsten Release des Endereco AMS Moduls für Magento2 von GitHub herunter.

Option 2: Installation über den Composer

Hierfür einfach den Befehl unten ausführen.

composer require devcccc/magento2-address-validation

php bin/magento module:enable CCCC_Addressvalidation
php bin/magento setup:upgrade

//optional bei Produktivsystemen:

bin/magento setup:di:compile
bin/magento setup:static-content:deploy

2.2 Update des Moduls

Um Endereco Client für Magento auf neuesten Stand zu bringen, rufen Sie einfach

//download des moduls
composer update devcccc/magento2-address-validation

//aktivieren des moduls
php bin/magento setup:upgrade

//optional bei Produktivsystemen:
bin/magento setup:di:compile
bin/magento setup:static-content:deploy

2.3 Aktivieren des Moduls im Magento Backend

Du kannst ganz einfach den Modul im Backend unter
Shops => Konfiguration CCCC Config => Address Validation: Endereco aktivieren

Zugangsdaten anfordern

3.1 Test Zugangzdaten

Das Modul funktioniert nur mit gültigen Zugangsdaten. Diese kannst du auf unsere Webseite unter //www.endereco.de/magento/ oder direkt per E-Mail an info@endereco.de kostenfrei beantragen.

Du kannst dann das Modul inklusive alle Services 30 Tage unverbindlich testen.

3.2 Live Zugangsdaten

Für die Live Zugangsdaten benötigen wir zwei unterschriebene und freigegebene Verträge, nämlich Providervertrag und Datenverarbeitungsvertrag. Beide Verträge finden Sie in Ihrem Installationspaket. Natürlich lassen wir Ihnen die Verträge gerne nochmal per E-Mail zukommen.

Zur Datenverarbeitungsvertrag: Für einige Services, in denen wir laut DSGVO persönliche Daten des Kunden verarbeiten oder an Dritte über Schnittstellen weitergeben, benötigen wir einen Datenverarbeitungsvertrag. Zum Beispiel wenn es um eine E-Mail Zustellbarkeitsprüfung oder Telefonnummern-Normierung geht. Diesen finden Sie ebenfalls im Installationspaket.

Bitte senden Sie beide unterschriebene Verträge an
info@endereco.de oder per Fax an: 0931 6639839-9 oder per Post an uns.
Wir benötigen eine Freigabe der Deutschen Post, die ca. 2-3 Tage dauern kann.

Endereco UG (haftungsbeschränkt)
Robert Rieser
Balthasar-Neumann-Str. 4b,
97236 Randersacker

Konfiguration des Moduls 

Hier findest du die Erläuterungen zu den einzelnen Moduleinstellungen und deren Funktionsweise im Backend des Magento2 Moduls.

4.1 Eingabe der Zugangsdaten und Grundeinstellungen

In den Moduleinstellungen kannst du nun die Zugangsdaten hinterlegen und die Grundeinstellungen konfigurieren.

Enable Integration:
Damit können alle Funktionen des Moduls für eine Webseite ein & ausgeschaltet werden.

Auth Key: Hier sollst du den von Endereco erhaltenen Api-Key hinterlegen. Achte darauf, dass hier keine Leerzeichen mit reinkopiert werden.

API URL: Diese sollte auf //endereco-service.de/rpc/v1 zeigen.

Optional können wir auch eine Staging URL bereitstellen, z.B. für das Testen neuer Funktionen.

Referer-Mode: hier sollte nur die Base-URL übermittelt werden. Ansonsten werden die zu prüfenden Adressen in Klartext über die URL an Endereco übermittelt.


4.2 Feldermatching

Die Endereco Adressprüfung arbeitet mit den Feldern

  • Land
  • Ort
  • PLZ
  • Straße
  • Hausnummer
  • Adresszusatz (Optional)

Diese müssen korrekt zugewiesen werden.

Du kannst für Straße + Hausnummer “street[0]” zuweisen oder getrennt, also

  • Straße: street[0] und
  • House number: street [0]

oder

  • Straße: street[0] und
  • House number: street [1]

Endereco kann Straße und Hausnummer trennen, wenn sie in einem Feld übergeben werden und somit einzeln wieder zurückliefen. Das ist sinnvoll um z.B. zu erkennen, ob eine Hausnummer vergessen wurde. Dafür müssen wir auf Server-Seite die richtige Konfiguration setzen, um den Adress-Splitter zu aktivieren.

Weiterhin ist es möglich einen Adresszusatz zu erkennen und diesen von Straße und Hausnummer abzutrennen, falls er im falschen Feld hinterlegt wurde. (BETA)

4.3 Einzelne Funktionen aktivieren

Folgende Features kannst du aktuell nutzen:

  • Adressprüfung für Rechnungs- und Lieferadresse
  • E-Mail Prüfung

Adresscheck: prüft eine Adresse auf Korrektheit mit dem Absenden des Formulars (on Submit). 

Je nach Ergebnis werden dem Kunden unterschiedliche Informationen zurückgeliefert

  • Adresse korrekt – keine Änderung notwendig
  • Adresse normiert – nur kleine Änderungen
  • Adresse mit Korrekturvorschlag
  • Adresse mehrdeutig – Adressliste zur Auswahl
  • Adresse nicht gefunden Meldung
  • Adresse unvollständig

Force Valid Address: Hindert den Kunden am Checkout, wenn er keine von Endereco als gültig geprüfte Adresse hinterlegt. Dies ist im Zweifel nicht empfehlenswert, das z.B. durch Neubaugebiete oder andere Dinge wie Eingemeindungen usw. nicht von einer immer 100% vollständigen und aktuellen Datenbasis auszugehen ist.

E-Mail Check: Die E-Mail Adresse wird auf Syntax und Erreichbarkeit geprüft. Dabei wird neben der formal richtigen E-Mail auch z.B. die Länderdomain auf Gültigkeit geprüft sowie auf dem Mailserver eine MX Validieren durchgeführt. Die meisten E-Mail Server sind so konfiguriert, dass sie Auskunft über die Zustellfähigkeit und Erreichbarkeit eines E-Mail Postfaches geben.

Du kannst weiterhin entscheiden welche der Kunden-Adressen geprüft werden. 

  • Rechnungsadressen
  • Lieferadressen
  • Adressen des Adressbuches

Es wird immer beim Gang zum Checkout, d.h. bei Kunden mit Kaufabsicht geprüft. 

4.4 Entwicklereinstellungen

Folgende Einstellungen kannst du aktivieren:

  • Javascript-Debugging
  • Write Validation log
  • Write validation log
    Für jeden Request/Response wird ein eindeutiger Hash erzeugt, der im Log jeder Meldung vorangestellt wird – so lässt sich auch bei parallelen Anfragen leicht ermitteln, welche Meldungen zusammengehören.
  • Enable Javascript Debugging
    Es werden console.debug-Meldungen in der Entwicklerkonsole des Browsers protokolliert, an denen erkennbar ist, welche Operationen durchgeführt werden. Ausgehend von diesen Meldungen können dann auch entsprechende JavaScript-Breakpoints gesetzt werden.

Funktionstest 

Nun sollten Sie nach Auswahl des Landes „Deutschland“ und der Eingabe einer PLZ passende Vorschläge für den Ort erhalten. Ebenso sollten Suggests bei der Eingabe der Straße erscheinen.

Viel Freude beim Einsatz unseres Moduls. Über Feedback, Anregungen und Rückmeldungen freuen wir uns. Nur so können wir unsere Services für Sie optimieren!

Bei Fragen helfen wir gerne weiter!
Einfach per E-Mail an: info@endereco.de oder Tel: 0931 66 39 839 – 0
Dein Endereco Team

Robert Rieser
CEO – Ansprechpartner für deine Anfragen

Du hast noch Fragen oder möchtest besondere Anforderungen besprechen?

Du kannst ein kostenfreies Meeting mit unseren Experten vereinbaren!

Auszug unserer Kunden

    Referenzen

    © Endereco UG (haftungsbeschränkt) - Gesellschaft für Master Data Quality Management - 2014 - 2021- Made with ♥ in Franconia