Function description #
Endereco Address Management Services (AMS) provides a simple and straightforward way to improve the quality of address data entered by your customers. Incorrect addresses can be corrected directly by customers by suggesting corrections. The spelling of addresses is standardized. For this purpose, a two-step process is integrated into the address forms, which ensures correct data entry across almost all input devices.
Installation instructions #
Reinstalling the module #
The module can be installed manually or vie composer
Option 1 - Manual installation:
Download the latest release of Endereco AMS module for Magento2 from GitHub.
Option 2 - installation via composer
Simply execute the command below
composer require devcccc/magento2-address-validation
php bin/magento module:enable CCCC_Addressvalidation
php bin/magento setup:upgrade
//optional for production systems:
bin/magento setup:di:compile
bin/magento setup:static-content:deploy#
Update of the already installed module #
To update Endereco Client for Magento 2, simply execute
//download the module
composer update devcccc/magento2-address-validation
//activate the module
php am/magento setup:upgrade
//optional for production systems:
am/magento setup:di:compile
am/magento setup:static-content:deployPS: 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 get from us. If you haven't received one yet, you can get it here or directly by sending an email to info@endereco.de .
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 as well as signed order processing contract. You can do this via 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 terms and conditions: 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: In this way all the funktions can be switched on and off
Auth Key: Here you should enter the API key received from Endereco. Make sure that no spaces are copied in 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 #
Endereco address verification is working with following fields
- Country
- Place
- ZIP CODE
- Street
- House number
- Additional Info (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.
Moreover it is possible to detect Additional Info und separate this from Street and House number. It is helpful wenn wrong field was used (Beta)
Activate individual functions #
Following services are available at the moment:
- Address verification for Bill- and delivery addresses
- E-mail verification
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 is not found
- Address incomplete
Force Valid Address: Prevents the customer from checking out if he does not deposit an address verified as valid by Endereco. This is not recommended in case of doubt that e.g. due to new construction areas or other things like incorporations etc. it cannot be assumed that the database is always 100 % complete and up-to-date.
E-Mail verification: The e-mail address is checked for syntax and accessibility. In addition to the formally correct e-mail, the country domain, for example, is also checked for validity and an MX validation is performed on the mail server. Most e-mail servers are configured to provide information about the deliverability and accessibility of an e-mail mailbox.
You can still decide which of the customer addresses will be checked.
- billing address
- shipping address
- Addresses of the address book
It is always checked when going to the checkout, i.e. for customers with the intention to buy.
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 #
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: 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.
For the provision of these functions, we use the service provider Endereco, Balthasar-Neumann-Straße 4b, 97236 Randersacker. The service provider processes the data exclusively according to our instructions. The legal basis for the transmission, processing and temporary storage of the data with the service provider is Art. 6 (1) lit. b DS-GVO, 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 is checked for accuracy. The following data is processed by the service provider:
- Address (country, city, postal code, street, house number if applicable)
- E-mail address (if not activated please delete)
- Phone number (if not activated please delete)
The data is processed separately at the service provider and not merged. The requests are deleted by the service provider as soon as the status of the entered data has been determined and the storage in the webshop has been completed, but at the latest after 30 days.
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.
