Magento 2 Integration Guide

Integration with Magento 2 address forms made simple

Visit the download page  

A step-by-step guide to integration with Magento 2 address forms.

Preparation

Compatibility

Our current releases support the latest version of Magento (v2.3.x at the time of writing), on both Community and Enterprise Edition.

Download

We recommended using Composer to install our Magento 2 plugins, but you can also download them from our website or the Magento Marketplace.

If you mostly target UK customers, our Postcode Lookup extension is recommended. For international data please use Address Auto-Complete.

Download Address Auto-Complete with Composer

Add the repository

Use this command in your Magento root to add the repository. Make sure that your minimum-stability is beta.

composer config repositories.craftyclicks git https://github.com/craftyclicks/magento2.git

Require the package

Add the latest version of Address Auto-Complete with the require command. You will be prompted to enter your Magento 2 access keys - the username is your public key and the password is your private key.

composer require craftyclicks/module-clicktoaddress

Alternatively, if you don't want to use the latest release you can install using a specific branch.

composer require craftyclicks/module-clicktoaddress:dev-branch

Now that you have successfully added the module in Composer, proceed to installation.

Download Postcode Lookup with Composer

Add the repository

Use this command in your Magento root to add the repository. Make sure that your minimum-stability is beta.

composer config repositories.craftyclicks git https://github.com/craftyclicks/m2-ukpostcodelookup.git

Require the package

Add the latest version of Postcode Lookup with the require command. You will be prompted to enter your Magento 2 access keys - the username is your public key and the password is your private key.

composer require craftyclicks/module-ukpostcodelookup

Alternatively, if you don't want to use the latest release you install using a specific branch.

composer require craftyclicks/module-ukpostcodelookup:dev-branch

Now that you have successfully added the module in Composer, proceed to installation.

Manual Download

  • Download one of our extensions.
  • For Address Auto-Complete, create this folder structure in your Magento root: /app/code/Craftyclicks/Clicktoaddress/. For UK Postcode Lookup, create this folder structure: /app/code/Craftyclicks/Ukpostcodelookup/
  • Copy the contents of the extension (etc, Helper, Model, and so on) into the Clicktoaddress or Ukpostcodelookup folder you just created.

Once you have successfully uploaded the files to your Magento site, proceed to installation.

Sign Up

Next, you need to sign up for a Crafty Clicks account.

When you sign up, you will receive an access token by email. There is no obligation to buy anything and you automatically get 100 trial lookups. If you need more lookups to test the integration, please get in touch (support@craftyclicks.co.uk) and we will try to accommodate you.

Installation

Please note that executing these lines will cause downtime on your Magento shop until they finish.

php bin/magento setup:upgrade
php bin/magento setup:di:compile
  • The first line allows Magento to recognize the module
  • The second line is required so that Magento would load configuration defaults.

Everything is installed! Now login to the Magento 2 admin panel and configure your access token.

Configuration

The settings for Address Auto-Complete are located at Stores -> Configuration -> Crafty Clicks -> Click to Address.

The settings for Postcode Lookup are located at Stores -> Configuration -> Crafty Clicks -> UK Postcode Lookup.

FAQ

Test

Before you go live, test the integration to make sure it is working properly.

If you need assistance, drop us an email on support@craftyclicks.co.uk – we will help!

Go Live

Once your trial lookups run out, you will need to decide on the best purchasing option based on the volume of usage you expect on your site. If you would like us to advise you then please get in touch.

Questions

  • Do you offer support? Yes, we do offer support during normal business hours in the UK. If you run into any issues, let us know and we will be happy to help.
  • Is this free? The extension is free to download and try, but to use it on a live site you will need a paid account with us.
  • Do I need to sign up for an account to try it? Yes, you’ll need a trial account, at least. You can easily sign up for a free trial account.
Last Updated: 7/1/2019, 12:08:26 PM