Get Started
Our Products
- Address Capture
- Address Verify
- Store Finder
- Email Validation
- Phone Validation
- Bank Validation
- Geocode
- Data Maintenance
- Utilities Register
Integrations
- All integrations
- Adobe Commerce (Magento)
- BigCommerce
- commercetools
- Microsoft Dynamics 365
- Salesforce CRM
- Shopify Plus
- Shopware 6
Common integration questions
Tag integrations
Yes, this is a great way to get the Loqate Tag working on your website quickly and easily.
If you are unfamiliar with Google Tag Manager, begin by reading About Google Tag Manager. To add the Loqate Tag to your container in Google Tag Manager:
- Click ‘Add a new tag’
- Select ‘Custom HTML Tag’
- Enter Loqate as the Tag name and paste the Loqate Tag code into the HTML field
- Select ‘Continue’ and then ‘Fire On’ > ‘All pages’ to ensure the Loqate Tag loads on all pages of your website.
- Click ‘Create Tag’ then ‘Publish’ at the top right corner.
Your Loqate Tag is now installed on your website and you are ready to continue setting up Loqate services, eg: Capture.
To complete this process, you must have access to your website source code, be comfortable editing HTML (or have a webmaster/developer who can help you), and have a Loqate account and service set up.
To set up the Loqate Tag:
- Log into your Loqate account and choose to set up the Capture service, after selecting where you will use Capture, you will be presented with the Loqate Tag code. The tag is in a box, it starts with . Click the ‘copy’ button to copy it to your clipboard.
- The Loqate Tag code contains your unique account ID, don’t mix up code snippets from different accounts.
- You might want to paste it into a text document if you’re worried about accidentally losing or changing the snippet from your clipboard.
- Paste your snippet (unaltered, in its entirety) into every web page. Paste it before the closing tag of your website HTML.
- If you use templates to dynamically generate pages for your site (like if you use PHP, ASP, or a similar technology), you can paste the tracking code snippet into its own file, then include it in your page header.
Yes, you will need to use a program to host the website locally, such as IIS (Windows) or Apache (Mac/Windows). You will need to create a new site in your hosting programme, and then map it to the file or folder containing the pages you want to set the Tag up on. In the site bindings set the port to 80, then run the website, the URL should look something like this: http://localhost/ (this is the URL you will need to enter during our Tag setup process).
There are two ways to add the Loqate Tag to your website:
- Add the Loqate Tag to your website using a Tag Manager such as Google Tag Manager
- Add the Loqate Tag directly into the HTML of every page of your website. This is the easiest method, especially if you do not already use a tag manager.
Firstly, check that we are looking at the right website - are there any typos in the website address that you entered? Secondly, did you paste the Loqate Tag code in the right place - save and re-upload your webpages to make sure. Finally, it’s possible your website is cached which means we can’t yet retrieve the updated files that contain the Loqate Tag - see the ‘What can I do if my website is cached?’ question below for help with this.
Adding the Loqate Tag site-wide is the easiest way for you to set up Loqate services. It will allow you to add our new and existing services to any page of your website in future without the need to involve a web developer each time. Sometimes it’s tricky to find the right stage to add the code, so by doing it this way you know for sure our service will work on the pages you need it to.
General integrations
If you’re not setting up the Loqate Tag on a website, you can use the Loqate API to implement our services in any application.
If your website is not showing recent updates you made then it may need its cache cleared. If you host your own site then speak to your technical team for help. If you do not host your own site then you might need to contact the support team at your hosting provider, or inspect your admin tools for an option to clear the site cache. Sometimes the cache will clear automatically after an hour or so, it’s worth checking again later if you have this problem.
Your account details can be restricted to your specific URL in fact we recommend you do this. This means that even with code types where your details are visible, they are still safe and secure. Anyone attempting to use them from another site would have their requests rejected and you’d be alerted via email.
The 1001 ID Invalid error message indicates that you are passing the wrong type of ID into the Retrieve service. You should only pass an ID from the Find service where the Type was returned as “Address”. Passing IDs of type “Postcode” will not result in a retrieve - instead, these should be passed back into the Find service as “Container” until an “Address” type is returned.
Address API example
First, use the Find method, triggering a lookup after each user keystroke in a search box.
Example request: https://api.addressy.com/Capture/Interactive/Find/1/json.ws?key=AA11-AA11-AA11-AA11&Text=wr2&Container=&Origin=&Limit=&Language=&Countries=
Present the Text/Description portion of the response to the user, usually in a container that allows them to click on a desired result. When the user clicks an item, check the “Type” portion of the item:
- If the Type parameter is anything but “Address”, perform another Find putting the Id into the Container parameter. Maintain the Container parameter until another click is made.
Note the Type parameter will only be “Address” when it is a full address the user is selecting, otherwise they need to carry on narrowing down their search results
by either typing more or clicking a further item from the results. Example subsequent Find:
https://api.addressy.com/Capture/Interactive/Find/1/json.ws?key=AA11-AA11-AA11-AA11&Text=wr2&Method=Match&Container=GB|RM|A|P-WR2-4AA&Origin=&Limit=&Language=&Countries= - If the Type parameter is “Address” then perform a Retrieve using the Id for that item from the response. Example Retrieve:
https://api.addressy.com/Capture/Interactive/Retrieve/1/json.ws?key=AA11-AA11-AA11-AA11&Id=GBR%7C52509479
Yes, our IP Limiter blocks all IPs that are not on your valid IP list. Only the IPs on your valid IPs list can do lookups. The list of your valid IPs can be found under Menu > Your Services > Click on the Key and ‘Limits’.
If you get a message saying a certain IP is blocked but this IP is not on your blacklist then that means IP Limit is enabled. ‘Limit by IP’ means you can restrict the service to specific IP addresses. If the blocked IP is not on the ‘Limit by IP’ list it can’t use the service.
If the IP is valid, you can add it to the ‘Limit by IP’ list to enable access. You can find ‘Limit by IP’ under Menu > Your Services > Click on the specific Key and select ‘Limits’.
Was this page helpful?