README

What is the Loqate API Integration?

Performs address capture and data validation (email, phone number and address) using Loqate API.

Download

Download via composer

Request composer to fetch the module:

composer require loqate-integration/adobe

Manual Download

Download & copy the git content to /app/code/Loqate/ApiIntegration.

Install

Please run the following commands after you download the module.

php bin/magento module:enable Loqate_ApiIntegration
php bin/magento setup:upgrade
php bin/magento setup:di:compile

Configuration Instructions

The configuration for the module is located under Stores -> Configuration -> Loqate.

Magento 2 DevContainer Setup

This repository includes a devcontainer for rapid Magento 2 extension development.

Quick Start

1. Create a devcontainer.env: Before opening the devcontainer you will need to create a devcontainer.env file which you can copy from devcontainer.env.example.
2. Open in VS Code: Use the "Reopen in Container" command (requires the Remote - Containers extension).
3. Wait for Setup: The devcontainer will build, install dependencies, and set up Magento 2 automatically.
4. Access Magento:
   • Storefront: http://localhost:8080
   • Admin: http://localhost:8080/admin
   • Default admin user: admin / admin123
5. Live Extension Development: Your extension source is mounted into the running Magento instance. Changes are reflected immediately after running bin/magento setup:upgrade and clearing cache.

Services

• PHP-FPM (8.1)
• Nginx
• MySQL 8
• Opensearch
• Redis

Notes

• The first startup may take several minutes (Magento install, Composer, DB setup).
• The extension is symlinked into app/code/Loqate/ApiIntegration.
• To re-run setup, use .devcontainer/setup-magento.sh inside the container.
• If you have any DNS issues, you will need to copy your Zscaler certificate into the PHP container - see the Zscaler workaround comment in the Dockerfile.

Useful helpers

• php -r '$e=include "app/etc/env.php"; $d=$e["db"]["connection"]["default"]; printf("mysql -h%s -u%s -p%s %s\n",$d["host"],$d["username"],$d["password"],$d["dbname"]);' Will extract the command to access mysql within the devcontainer, currently that command is mysql -hdb -umagento -pmagento magento
• bin/magento config:show will list all of the config currently set in the instance, this can be set with bin/magento config:set <PATH> <VALUE>