Skip to content

Commit

Permalink
Update README, screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
JerrySmidt committed Jun 5, 2023
1 parent 6913e83 commit 8fa3f34
Show file tree
Hide file tree
Showing 10 changed files with 76 additions and 21 deletions.
70 changes: 49 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
Postcode.eu International Address API module for Magento 2
=============
![Postcode.eu](media/postcode-eu-logo-gradient.svg)

Adds autocompletion for addresses to the checkout page. Multiple countries are supported using official postal data via the [Postcode.eu](https://postcode.eu) API.
# International Address API module for Magento 2

This module has been created by [Postcode.nl](https://postcode.nl) and [Flekto](https://www.flekto.nl).
Adds autocompletion for addresses to the checkout page. [Multiple countries](https://www.postcode.nl/services/adresdata/internationaal) are supported using official postal data via the [Postcode.eu](https://postcode.eu) API.

This module is maintained by [Postcode.nl](https://postcode.nl) since version 3.0.0. Earlier versions were developed by [Flekto](https://www.flekto.nl).

Postcode.eu Account
=============
# Postcode.eu account

A [Postcode.eu account](https://www.postcode.nl/en/services/adresdata/producten-overzicht) is required.
Testing is free. After testing you can choose to purchase a subscription.

Installation instructions
=============
# Installation instructions

1. Install this component using Composer:

Expand All @@ -28,6 +26,41 @@ $ php bin/magento setup:di:compile
$ php bin/magento cache:flush
```

# Screenshots

## International Address API

A single field for autocompletion:

![](media/example-intl-api-be.png)
![](media/example-intl-api-de.png)

To allow users to skip the autocomplete field and manually enter an address, there's an option to add a link to manual address entry:

![](media/example-intl-api-manual-entry-option.png)

## Dutch Postcode API

Get a Dutch address by postcode and house number. In this example asking the user to select from valid house number additions:

![](media/example-nl-api-house-number-addition.png)

A formatted address is shown when the postcode and house number combination is valid (this is the default output option):

![](media/example-nl-api-formatted-output.png)

Other output options are:

* Hide address fields until postcode and house number combination is valid.
* Disable address fields until postcode and house number combination is valid.
* No change; address fields remain visible and editable.

# Compatibility

Although we can't guarantee compatibility with other checkout modules, our module works well with most one-step-checkout modules. If you are having issues and think this may be caused by our module, please [contact Postcode.nl](tech@postcode.nl) and tell us which other module(s) and version(s) are used.

If you found the solution already and have some code to contribute, feel free to open a pull request in this repository.

## OneStepCheckout.com configuration instructions

1. Go to Stores -> Configuration -> Sales -> Postcode.eu Address API
Expand All @@ -45,23 +78,18 @@ $ php bin/magento cache:flush
4. address_autofill_intl
5. address_autofill_formatted_output
3. Optional: you may need to apply some custom CSS to display the fields correctly. You may set the region field to hidden.

License
=============

The code is available under the Simplified BSD License, see the included LICENSE file.

Screenshots
=============

International autocomplete:
# Address API documentation

![](address-autofill-intl.png)
You can find our API documentation at https://developer.postcode.eu/documentation.

Dutch address by postcode and house number:
# FAQ and Knowledge Base

![](address-autofill-nl-house-number-addition.png)
* View Frequently Asked Questions at https://www.postcode.eu/#faq.
* For more questions and answers, see https://kb.postcode.nl/help
* If the above didn't answer your question, [contact us](https://www.postcode.eu/contact).

Option to show formatted output:
# License

![](address-autofill-nl-formatted-output.png)
The code is available under the Simplified BSD License, see the included LICENSE file.
Binary file removed address-autofill-intl.png
Binary file not shown.
Binary file removed address-autofill-nl-formatted-output.png
Binary file not shown.
Binary file removed address-autofill-nl-house-number-addition.png
Binary file not shown.
Binary file added media/example-intl-api-be.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/example-intl-api-de.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/example-intl-api-manual-entry-option.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/example-nl-api-formatted-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/example-nl-api-house-number-addition.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions media/postcode-eu-logo-gradient.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8fa3f34

Please sign in to comment.