Installation Guide for OXID 6

Endereco Address Management Service Module (AMS)
For OXID 6.x PE, CE & EE

Current release notes:

Version 3.2.4:

  • New data sources installed, better address quality possible
  • Service side TID generation
  • Summary of the services into packages: Address Services, Email Services, Phone Services, Name Services. Affected is mainly the address service that consists of input Assistant and AddressCheck.
  • Improvement of the Client UX
  • Bug fixing
  • Existing customers are also checked (optional)
  • Client detects the failure of the remote servers and reacts accordingly.

Functional description

Endereco Address Management Services provide a simple and straightforward way to improve the quality of the address data entered by your customers. To this end, a two-step process is integrated into the address forms to ensure that data is captured correctly on almost all input devices.

Level 1

a) Input Assistant - Input help

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) First name check - Does the form of address 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) E-mail verification

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 mailbox full or deliverable?
  • If it is a one-way address or SPAM e-mail address
d) Telephone numbers Standardisation

Different ways of writing telephone numbers are very common. Endereco tidies up and gives telephone numbers a uniform, standardised spelling. In addition, Endereco distinguishes between mobile numbers and landline numbers and can include this feature if desired. Invalid prefixes are recognized and marked

Level 2

a) AddressCheck

The address check validates entered fields for validity in the overall context. Valid correction proposals are automatically offered for entries that are not plausible. The customer can choose between his entry and one of the correction codes.


Installation

2.1 Installation of the module

For this simply use the composer require endereco/enderecoclientox in the root folder of the shop. This will download the module and register the namespaces.

2.2 Update of the module

To update Endereco Client for OXID, simply call composer update endereco/enderecoclientox on.

2.3 Adjusting the field order

To do this, you simply fit in the template files

"application/views/MYTHEME/tpl/form/fieldset/user_billing.tpl"

"application/views/MYTHEME /tpl/form/fieldset/user_shipping.tpl"

the order of the input fields by simply changing the block order in the two files. The correct order in billing address and delivery address is

COUNTRY
Postcode / City
Street / House number

Therefore the following blocks in the code must be swapped:

Before After
Additional Info "div" Element additional info
StreetAndNo "div" element Country + State (Block Element)
PostcodeAndCIty "div" element PostcodeAndCIty "div" element
Country + State (Block Element) StreetAndNo "div" element
VatIdNo VatIdNo

Example: Swap "street" and "postal code":

Before After

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

2.4 Activating the module in the admin backend

  • Log in to the backend
  • Extension → Click on the module → "Endereco AMS".
  • Click on the "Trunk" tab.
  • Click on the button to the right called "Activate".

Request access data

3.1 Test access data

The module only works with valid access data, which you can download from our website at //www.endereco.de/oxid-eshop/ or directly by e-mail to info@endereco.de free of charge.

You can then test the module including all services for 30 days without obligation.

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 shop backend click on Endereco - address validation
  • Select settings
  • Enter API key, select service endpoint
  • Save entries

Configuration of the module 

4.1 Selecting the test mode

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

"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.

"address services" include Input Assistant and address validation. The Input Assistant generates the suggestions for postcode, associated city and streets for the customer based on the entered data, and automatically inserts selected data in the corresponding address fields. In case of address validation, all address data are 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.

"Check addresses also for existing customers" means that the address data of existing customers are also checked once at checkout.

"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.

"Phone Service" 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 telephone numbers.

4.2 Choice of styling (.css file)

module has been extensively tested with various oxide themes and optimized for them. We support

  • Flow (Responsive Theme)
  • Wave (Responsive Theme)
  • Azure (Standard Oxide Theme)
  • Roxide (Responsive Theme)
  • RoxIVE (Responsive Theme) <- Select also for the FLOW theme
  • Custom (Individual Theme)

By selecting the respective entry, the appropriate styling (style sheet) is selected for each installed template. You can adapt this to your requirements.

Our module usually detects the installed theme, and usually configures itself. Now you have the possibility to customize colors for different functions.

Insert bootstrap into modal?

Should CSS be inserted for Bootstrap Modal? (Please only if no bootstrap is used!)

Usually the switch can be left off, because most themes are already based on bootsrap.

This completes the setup. Please empty the temp folder of your webshop before using the module.


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 3.2.4:

  • New data sources installed, better address quality possible
  • Service side TID generation
  • Summary of the services into packages: Address Services, Email Services, Phone Services, Name Services. Affected is mainly the address service that consists of input Assistant and AddressCheck.
  • Improvement of the Client UX
  • Bug fixing
  • Existing customers are also checked (optional)
  • Client detects the failure of the remote servers and reacts accordingly.

Version 3.2.3:

Version 3.2.2:

Version 3.2.1:

Version 3.1:

Version 3.0 Major Release:

  • Feature: JSON interface as basis for the new Endereco address module
  • Feature: URLs updated
  • Feature: International address validation and autocomplete
  • Feature: Phone normalization and formatting of the phone number
  • Feature: E-mail addresses Check and deliverability to mail servers are checked
  • Feature: The backend of the module was revised and better structured
  • Feature: The new Wave Theme is now supported
  • Release based on OXID 6 installable via Composer

Extract of our customers

    References

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