Functional description #
The endereco Address Management Services (AMS) enable you to improve the quality of the address data entered by your customers in a simple and uncomplicated way. Customers can correct incorrect addresses directly by suggesting corrections. The spelling of addresses is standardized. A two-stage process is integrated into the address forms for this purpose, which ensures that data is entered correctly across almost all input devices.
Installation instructions #
Reinstalling the module #
The installation can be done manually or via the Composer.
Option 1 - Manual installation:
Download the latest release of the endereco AMS module for Magento2 from GitHub.
Option 2 - installation via composer
To do this, execute the following command below.
composer config repositories.endereco git https://github.com/Endereco/magento2-address-validation.git
composer require endereco/magento2-address-validationphp bin/magento module:enable Endereco_Addressvalidation
php bin/magento setup:upgrade
Update of the already installed module #
To update endereco Client for Magento to the latest version, simply call
// 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: Subscribe for our Release Newsletter and you will always be informed when an update is available.
Activate the module in the admin backend #
Request access data #
Access data #
The module only works with a valid API key, which you will receive from us. If you have not yet received one, you can request it here or directly by e-mail to info@endereco.de free of charge.
You can try the module 30 days free of charge on your test instance or in the live store from the moment you receive the API key and use all functions.
Limitation:
For licensing reasons, the test is not performed at the house number level during the test period. We will activate this for you in live operation! You can find more conditions here.
Switch to the paid productive mode #
For the live access data, we need your consent to our terms and conditions and the signed order processing contract. You can do this using our form: Use of Endereco Services.
Regarding the order processing contract: For some services in which, according to the DSGVO, we process the customer's personal data or pass it on to third parties via interfaces, we require a data processing contract.
To our AGB's: www.endereco.de/agb
We need an approval from the German Post, which can take about 2-3 days.
Configuration of the module #
Basic settings #
In the module settings you can now define the access data and configure the services.
Enable Integration: This allows all functions of the module to be switched on and off for a website.
Auth Key: Here you should enter the Api key received from endereco. Make sure that no spaces are copied here.
API URL: This should be based on https://endereco-service.de/rpc/v1 show
Optional we can give you an access to our Staging Server, mainly for testing purposes.
Referer mode: Only the base URL should be transmitted here. Otherwise, the addresses to be checked are transmitted to endereco in plain text via the URL.
Field Matching #
The endereco address check works with the fields
- Country
- Place
- ZIP CODE
- Street
- House number
- Address suffix (optional)
These must be assigned correctly.
You can assign „street [0]“ for street + house number or separately, i.e.
- Street: street [0] and
- House number: street [0]
or
- Street: street [0] and
- House number: street [1]
Endereco can separate street and house number if they are passed in one field and thus returned separately. This is useful, for example, in order to detect whether a house number has been forgotten. For this purpose, we have to set the correct configuration on the server side to activate the address splitter.
It is also possible to recognize an address supplement and separate it from the street and house number if it has been entered in the wrong field.
Activate individual functions #
Following services are available at the moment:
- Address verification for Bill- and delivery addresses
- Email check
Address verification: validates an address with the submission of the form (on Submit).
Depending on the result, customer will receive different information
- Address correct - no change necessary
- Address normalized - only minor changes
- Address with correction suggestion
- Address ambiguous - address list for selection
- Address not found - Message
- Address incomplete
Force Valid Address: Prevents the customer from checking out if they do not enter an address that has been verified as valid by endereco. In case of doubt, this is not recommended, as a 100% complete database cannot be assumed, e.g. due to new development areas or incorporations.
E-mail check: The email address is checked for syntax and accessibility. In addition to the formally correct email, the country domain, for example, is also checked for validity and an „MX validation performed“ on the mail server. Most email servers are configured in such a way that they provide information about the deliverability and accessibility of an email inbox.
You can still decide which of the customer addresses will be checked.
- billing address
- shipping address
- Addresses of the address book
This is always checked at checkout, i.e. for customers intending to make a purchase.
Developer settings #
Following setting are available:
- Javascript Debugging
- Write Validation log
- Write validation log
A unique hash is generated for each request/response, which is prepended to each message in the log - this makes it easy to determine which messages belong together, even with parallel requests. - Enable Javascript Debugging
Console. debug messages are logged in the developer console of the browser, from which it can be seen which operations are being performed. Based on these messages, appropriate JavaScript breakpoints can then also be set.
Functional test #
After selecting the country „Germany“ and entering a zip code, you should now receive suitable suggestions for the city. Suggestions should also appear when you enter the street.
We hope you enjoy using our module. We welcome feedback, suggestions and feedback. This is the only way we can optimize our services for our customers!
If you have any questions we will be happy to help you!
Simply send an e-mail to: support@endereco.de or Tel: 0931 66 39 839 - 0
Your endereco team
Add privacy policy #
Now you should still inform your customers that we check the address data, possibly also other personal data.
You now have 2 options to include this information:
We have created a text proposal for you, which you can include in your privacy policy. Customize the proposal according to the booked services.
On our website we offer you the possibility to check certain entries in address forms of our webshop for input errors in real time. This is to avoid problems with the delivery of the products you ordered due to incorrect information.
Furthermore, we want to ensure that their contact information is valid for sending information about their order or for any necessary queries.
We use the service provider endereco, Balthasar-Neumann-Straße 4b, 97236 Randersacker, Germany, to provide these functions. The service provider processes the data exclusively in accordance with our instructions. The legal basis for the transmission, processing and temporary storage of the data by the service provider is Art. 6 para. 1 lit. b GDPR, as it is absolutely necessary for the fulfillment of the contract or for the implementation of pre-contractual measures that some of the data entered by you in the input mask are checked for correctness. The following data is processed by the service provider
Address (country, town, zip code, street, house number if applicable)
E-mail address (please delete if not activated)
Phone number (if not activated please delete)
The data is processed separately by the service provider and is not merged. The requests are deleted by the service provider as soon as the status of the data entered has been determined and storage in the web store has been completed, but after 30 days at the latest.
If you are already a customer of IT Law Firm and manage your legal texts there, you can easily add another text section to your other privacy policy content.
