Installationsanleitung für Magento2

endereco Adressmanagement Service Modul (AMS)

Für Magento 2.2.x – 2.4.x

Aktuelle Release Notes

Funktionsbeschreibung #

Die endereco Adressmanagement 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.

Inhalt bearbeiten

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.

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?
Inhalt bearbeiten

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.

Installationsanleitung #

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 folgenden Befehl unten ausführen.

composer config repositories.endereco git https://github.com/Endereco/magento2-address-validation.git
composer require endereco/magento2-address-validation
php bin/magento module:enable Endereco_Addressvalidation
php bin/magento setup:upgrade

Update des bereits installierten Moduls #

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

// download module

composer update endereco/magento2-address-validation
 

// activate module

php bin/magento setup:upgrade
 

// optional on production servers:

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

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

Aktivieren des Moduls im Admin Backend #

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

Zugangsdaten anfordern #

Zugangsdaten #

Das Modul funktioniert nur mit einem gültigen API-Schlüssel, den du von uns bekommst. Falls du noch keinen erhalten hast, kannst du ihn hier oder direkt per E-Mail an info@endereco.de kostenfrei anfordern.

Du kannst das Modul ab Erhalt des API-Schlüssels 30 Tage kostenfrei auf deiner Testinstanz oder im Liveshop ausprobieren und alle Funktionen nutzen.

Einschränkung:

Aus lizenztechnischen Gründen erfolgt die Prüfung während des Testzeitraums nicht auf Hausnummernebene. Diese schalten wir im Live-Betrieb für dich frei! Weitere Konditionen findest du hier.

Wechsel in den kostenpflichtigen Produktivmodus #

Für die live Zugangsdaten benötigen wir deine Zustimmung zu unseren AGB's sowie den unterschriebenen Auftragsverarbeitungsvertrag. Das kannst du über unser Formular erledigen: Nutzung der Endereco Services.

Zum Auftragsverarbeitungsvertrag: 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.

Zu unseren AGB's: www.endereco.de/agb

Wir benötigen eine Freigabe der Deutschen Post, die ca. 2-3 Tage dauern kann.

Konfiguration des Moduls #

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- und ausgeschaltet werden.

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

API URL: Diese sollte auf https://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.

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. 

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, da z.B. durch Neubaugebiete oder Eingemeindungen nicht von einer 100% vollständigen 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

Das wird immer beim Checkout, d. h. bei Kunden mit Kaufabsicht geprüft.

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. Auch Vorschläge bei der Eingabe der Straße sollten 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 unsere Kunden optimieren!

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

Datenschutzerklärung ergänzen #

Nun solltest du noch deine Kunden darüber informieren, dass wir die Adressdaten, ggf. auch weitere personenbezogene Daten prüfen.

Du hast nun 2 Möglichkeiten, diese Informationen einzubinden:

Wir haben für Dich einen Textvorschlag erstellt, den du in deine Datenschutzerklärung aufnehmen kannst. Passe den Vorschlag gemäß der gebuchten Dienste individuell an.


Auf unserer Webseite bieten wir Ihnen die Möglichkeit, bestimmte Eingaben in Adressformularen unseres Webshops in Echtzeit auf Eingabefehler zu überprüfen. Dadurch sollen Probleme bei der Lieferung der von Ihnen bestellten Produkte durch falsche Angaben vermieden werden.

Weiterhin möchten wir sicherstellen, dass ihre Kontaktdaten zur Zusendung von Informationen zu ihrem Auftrag oder für ggf. notwendige Rückfragen gültig sind.

Für die Bereitstellung dieser Funktionen setzten wir den Dienstleister endereco, Balthasar-Neumann-Straße 4b, 97236 Randersacker ein. Der Dienstleister verarbeitet die Daten ausschließlich nach Weisung durch uns. Rechtsgrundlage für die Übermittlung, Verarbeitung und vorübergehende Speicherung der Daten beim Dienstleister ist Art. 6 Abs. 1 lit. b DSGVO, da es für die Erfüllung des Vertrags oder zur Durchführung von vorvertraglichen Maßnahmen zwingend erforderlich ist, dass einige der von Ihnen in die Eingabemaske eingegebenen Daten auf ihre Richtigkeit überprüft werden. Folgende Daten werden durch den Dienstleister verarbeitet:

  • Adresse (Land, Ort, Postleitzahl, Straße, ggf. Hausnummer)

  • E-Mail-Adresse (wenn nicht aktiviert bitte löschen)

  • Telefonnummer (wenn nicht aktiviert bitte löschen)

    Die Daten werden beim Dienstleister separat verarbeitet und nicht zusammengeführt. Die Anfragen werden beim Dienstleister gelöscht, sobald der Status der eingegebenen Daten ermittelt wurde und die Speicherung im Webshop abgeschlossen wurde, spätestens jedoch nach 30 Tagen.


Wenn du schon Kunde bei der IT-Recht-Kanzlei bist, und deine Rechtstexte dort verwaltest, kannst einen weiteren Textabschnitt einfach zu deinen anderen Inhalten der Datenschutzerklärung hinzufügen.

Im Rechtstexte Generator sind unsere endereco Services unter „Tools und Sonstiges“ > „Verwenden Sie Dienste für automatische Adressprüfung und Eingabekorrekturen“ gelistet.
What are your feelings
Updated on 12. September 2025

Anmeldung für den Newsletter

Gib hier deine Überschrift ein

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.