Installation instructions for Shopware

Endereco Address Management Service Module (AMS)
For Shopware 5.4.x - 5.6.x

Current release notes:

Version 2.2.2:

  • Support for RLT (Right to Left) input for Arab countries

Version 2.2.1:

  • New JS-SDK included
  • Triggered the address check when clicking "Continue" in the checkout process to allow address changes
  • API test button built-in
  • Bugs removed

Functional description

Endereco Address Management Services (AMS) is a simple and straightforward way to improve the quality of the address data entered by your customers. Incorrect addresses can be corrected directly by the customers through correction suggestions. The spelling of addresses is standardised . For this purpose, a two-stage process is integrated into the address forms, which ensures that the data is entered correctly via almost all input devices.

Step 1

a) Address entry wizard

Suggestions for entered address fragments are displayed in an autocomplete function of street, postcode and city. This works on PCs, tablets and smartphones. Address entry is simplified, accelerated and the error rate is massively reduced.

b) Salutation check (Does the salutation match the first name?)

The Endereco first name database with over 30,000 entries can recognise gender-specific first names and marks the corresponding salutation field of your webshop. Ambiguous or unknown names are ignored. Upper and lower case is automatically corrected.

c) Validation of the e-mail address

An entered e-mail address is checked for various characteristics in real time:

  • Valid syntax of the e-mail address
  • Valid country domain
  • Is the e-mail inbox registered and accessible?
  • Is the mailbox full or deliverable?
  • Is it a disposable address or SPAM e-mail address?

Step 2

a) AddressCheck

The address check validates entered address fields for validity in the overall context. For implausible entries, valid correction surcharges are automatically offered. The customer can choose between his entry and one of the correction thresholds.


Installation instructions

2.1 Installation of the module

Lade das Modul für Shopware 5.3.x und größer unter //github.com/Endereco/shopware-ams oder von unserer Webseite herunter: //www.endereco.de/download/ herunter und erstelle den Ordner "EnderecoAMS im Verzeichnis *myshopwareinstallation*/custom/Plugins/

Copy now via SFTP in binary mode the folder content into the created folder on your server.

When finished, the folder "EnderecoAMS" should be created here and contain the contents of the module package.

Now you should be able to see and activate the module in the shop backend.

2.2 Update of the module

To keep the Endereco Client for Shopware up to date, please download the latest version of www.endereco.de/downloads down.

Alternatively you can always find the latest release on Github. 

//github.com/Endereco/shopware-ams

We will gladly carry you into our Release Newsletter then you will always be informed quickly when an update is made. 

2.3 Adjusting the field order

By activating the module, the field order of the address fields is automatically adjusted to the following order:

COUNTRY
Postcode / City
Street / House number

After adjusting the field order, the address fields should look like this:

2.4 Activating the module in the shopware backend

  • Log in to the backend
  • Plugin Manager → Uninstalled modules → Click on "Endereco AMS
  • Install and activate

Request access data

3.1 Access data

The module only works with a valid API key, which you will get from us.

If you have not yet received one, you can download it from our website at //www.endereco.de/shopware/ or directly by e-mail to info@endereco.de free of charge.

You can now try out the module for 30 days free of charge on your test instance or in the liveshop and use all functions without restrictions.

We will get back to you after the test period or at half time and ask you how to proceed or if you have any problems.

3.2 Live access data

For the live access data we need two signed and approved contracts, namely provider contract and data processing contract. You will find both contracts in your installation package. Of course we will gladly send you the contracts again by e-mail.

About the data processing contract: For some services in which we process personal data of the customer or pass them on to third parties via interfaces according to the DSGVO, we need a data processing contract. For example, when it comes to an e-mail deliverability check or telephone number standardization. You will also find this in the installation package.

Please send both signed contracts to
info@endereco.de or by fax to: 0931 6639839-9 or by mail to us.
We need a release from the German Post, which can take about 2-3 days.

Endereco UG (limited liability)
Robert Rieser
Balthasar-Neumann-Str. 4b,
97236 Edge bag

3.3 Entering the access data

In the module settings you can now define the access data and configure the address checks.


Configuration of the module 

4.1 Selecting the test mode

You have the possibility to switch different services on and off:

  • Auto-completion for address data
  • Address verification
  • E-mail verification
  • Salutation check
  • Phone number validation

"Status display" adds warning and success icons to the form. An activation / deactivation has no influence on the functionality of other services. It only serves to visualize the check results.

"Input assistance and address check"  Input Assistant generates suggestions for the customer for postcode, city and streets based on the data entered and automatically inserts selected data into the corresponding address fields. In case of address validation, all address data is checked after leaving the address form fields. If there is an error, the customer is asked via a popup window whether he wants to keep his input or accept a correction suggestion, even if the customer logs in and is guided through the checkout process via the "address page". In this way, old master data can be cleaned up and addresses can be broken down in case of errors.

"Email verification" verifies the syntax, deliverability and existence of an entered email address. It also checks whether it is a disposable or spam address.

"Salutation check" determines whether selected salutation matches the first name and corrects upper and lower case. Names that are not known or may be ambiguous are not marked as incorrect.

"Area code check." verifies if a phone number prefix exists and formats the numbers according to the dialled format. There are 10 formats available. This function is currently only available for German phone numbers.

Fab settings - This allows you to adjust the colors for warnings, error texts and hints to the colors of your webshop.

This completes the setup. Before testing, please empty the temp folder of your webshop and go to the registration page.


Functional test 

Now, after selecting the country "Germany" and entering a postcode, you should receive suitable suggestions for the city. Suggestions should also appear when you enter the street.

Have fun using our module. We are looking forward to your feedback, suggestions and feedback. This is the only way we can optimize our services for you!

If you have any questions we will be happy to help you!
Simply send an e-mail to: info@endereco.de or Tel: 0931 66 39 839 - 0
Your Endereco Team


release notes 

Version 2.2.1:

  • demo release
  • New JS-SDK included
  • Submit is braked to allow address change (one-time)
  • API test button built-in
  • Some bugs fixed

Version 1.0:

  • Initial release of our shopware module for checking and correcting address data in
    Real time.

Extract of our customers

    References

    Copyright Endereco UG (haftungsbeschränkt) - Company for Master Data Quality Management
    2014 - 2020