Getting Started With Loqate
If you’re just starting with Loqate, you can use this page to orient yourself and get started with your integration. We’ll take you through five quick steps to get up and running, including making your first calls to the Loqate APIs, then provide some further reading at the end.
1. Create a Loqate account
If you haven’t already, sign up for a Loqate account.
Signing up for a new account gives you a 14 day free trial, which gives you the opportunity to test your integration, experiment with our range of products, and experience the practical benefits they can bring to your organisation.
2. Choose an integration method
You can integrate with Loqate in various ways, from auto-generated code snippets to full API integrations. The option you choose will be determined by the nature of your business and what you want to achieve.
For the purposes of this article, and for the sake of simplicity, we’re going to assume you’ll at least partially be using an API integration, but see our Ways to Integrate page for more information about all of the options.
3. Create an API key
All Loqate services require an API key for authentication purposes, so you’ll need to create one before you can start making any API calls.
You can set up generic API keys or service-specific keys, and then apply various limits and restrictions to each, but to begin with we recommend creating a generic API key for the purposes of initial testing and setup.
To do this, click on the Add Service + button at the top of the screen in your Account:
From the next screen select the API Key option, then you’ll see your newly-created key. Take note of the key (which we’ve blurred out in the image below for security purposes), but for the time being you don’t need to worry about any of the other options.
See our Creating API Keys page for full details of creating API keys and the various available options.
4. Make some API calls
If you’ve chosen a Tag setup (see the Ways to Integrate page for more details about this), you can go ahead and test the form(s) on your website to see how Address, Email and/or Phone Validation works.
If you’re going to be using APIs, the next step is to make some test calls using your new API key.
Here are some simple examples, which you can run in Postman or in a browser. Make sure you swap the placeholder API key (AA11-AA11-AA11-AA11) in each for your own API key.
5. Check your usage
Once you’ve made a few API calls, head over to the Reporting page in your account. Here you’ll be able to see usage summaries per key (or across your account as a whole), showing both charged and free requests and, if appropriate, the total cost of them so far. For example:
We recommend you regularly check the usage on your keys, to maintain visibility of how your services are being used.
For full details of these reports, see our Monitoring Account Usage page.
Other important considerations
Once you’ve set up and tested an API key, you can go ahead and put together your full integration. Some further considerations to take into account include:
What all the available service options are: there are lots of Loqate services available, so read through the List of Endpoints page to see what you might find useful. How to stay secure: we provide a range of features to help you ensure that your integration is as secure as possible. See the API Security page for full details.
Further reading
- API documentation
- Setup guides
- FAQs