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

New Plugin

You can now use all of our main products in a single Magento 2 plugin! The new plugin allows you to use Address Auto-Complete, UK Postcode Lookup, Phone Validation, and Email Validation.

If you are still using one of our stand-alone plugins, please follow this guide to switch to the new plugin when you're ready. If you have any questions please contact support.

# Preparation

# Compatibility

Our current release supports the latest version of Magento (v2.4.x at the time of writing), on both Community and Enterprise Edition.

# Download

We recommended using Composer to pull our plugin directly into your Magento 2 website, but you can also download it from our website.

# Composer

# Require the package

Add the latest version of our plugin with the following command. You may be prompted to enter your Magento 2 access keys - the username is your public key and the password is your private key.

composer require fetchify/module-fetchify

Now sign up for a Fetchify account if you haven't already done so, then proceed to installation.

# Manual Download

  • Download our extension.
  • Create this folder structure in your Magento root: /app/code/fetchify/module-fetchify.
  • Upload the contents of the extension (etc, Helper, Model, and so on) into the module-fetchify folder you just created.

Now sign up for a Fetchify account if you haven't already done so, then proceed to installation.

# Sign Up

To use any of our plugins, you need to sign up for a Fetchify account and receive an access token.

When you sign up, you will receive your access token by email. There is no obligation to buy anything and you automatically get 100 trial lookups. If you need more lookups for testing, please contact support and we will try to accommodate you.

# Installation

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

php bin/magento setup:upgrade
php bin/magento setup:di:compile

The plugin should now be successfully installed. Login to your Magento 2 admin area and configure the plugin.

# Configuration

First of all, set your access token at Stores -> Configuration -> Fetchify -> Main Settings.

Then decide which product(s) you want to use and make sure they are enabled. Each product has it's own dedicated configuration area where you can enable it and set various options. If you mostly target UK customers, then we recommend using UK Postcode Lookup. If you need international address data, use Address Auto-Complete instead.

Stores -> Configuration -> Fetchify -> Address Auto-Complete

Stores -> Configuration -> Fetchify -> UK Postcode Lookup

Stores -> Configuration -> Fetchify -> Phone Validation

Stores -> Configuration -> Fetchify -> Email Validation

After you set your access token and enable some products, you will be able to use them on any standard Magento 2 address form.


# 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@fetchify.com – 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: 11/19/2020, 2:14:13 PM