All Loqate services require a valid API key for authentication. Attempting to access any Loqate service without a valid API key will not succeed.
In this article we will explain how to create and maintain your API keys, all of which is done in the Loqate Account section.
In order to create an API key you will need a valid Loqate account. You can sign up for a free trial, which will get you up and running quickly.
You can create an API key in two ways:
For both options, navigate to the Setup page in the Loqate Account section by clicking the Add service + button at the top right of the screen.
Alternatively, you can select the Add a new service option from the home page.
When you select either of these options, you'll be taken to the following screen:
From here you can choose which type of key you want to set up. Without specific limits being applied (which we discuss more in the API key security section) Loqate API keys can generally be used for any service, but we recommend you take the following approach:
Note that Location List is not a service in its own right, but rather something that's required for the Store Finder service.
Once you've selected one of those options, in most cases you'll be taken to the Service Settings page for your new key.
Here's what the Service Settings page looks like for an Address Verification key:
The options you'll see on this page will depend on what type of key you've created.
Common options across all keys include:
Some keys include Customise sections in which you can set further options including default visuals and additional URL controls.
Generic API keys, along with Data Cleanse and Address Verification keys, also have the option of enabling additional datasets.
It's possible to use any API key with any Loqate service, however for security purposes we recommend you use each key with a specific service, and restrict it so that it can't be used anywhere else. This is just one of several security features available, and which we recommend you use to ensure the safety of your integration.
In the Limits section of each key's Service Settings page, you can limit the usage of the key in various ways, including:
For more information on these API key-specific security features, as well as various account-wide options, please see the main Security page.
We recommend you regularly check the usage for each API key - i.e. how many requests are being made and what the running costs are - in order to maintain visibility of how your services are being used.
You can find per-account and per-key usage summaries in the Reporting page of your Account Section. For example:
Please note that the Charged Requests field in these summaries represents the number of API calls that have been made, not the volume of transactions being processed in a batch.
For more information about usage and the various available reports, please see the dedicated Monitoring Account Usage page.