Getting Started With Your New Cloud Account
Posted by Dom K on Wednesday, July 27, 2016 - 19:57
So you registered for a 30-day trial and you’ve just clicked the big orange button in your welcome email! If so, a big hello from everyone in the Everything Location team.
If you got to this page in any other way, a big howdy to you, too!
Maybe you’re here with questions, such as “What is credit?” or “How do I use your API?” Maybe you want some more information about the trial works, too. Here’s in-depth information on our awesome product and your super awesome trial.
Before we start, it’s important to understand that our product is an API, and we count on our account users to either possess or have access to technical knowledge. If developer assistance is not available, please get in touch and we’ll do our best to assist.
1. Your API Key
This acts like an authentication key that you provide to all web service calls using the parameter lqt_key. The key remains functional as long as there is valid credit on the cloud account. When your trial credit either runs out or expires, the web service call using the key will return an error message.
Think of your credit balance as a big bucket of currency that you can spend on any of our API calls. Each call will consume a number of credits that are based on two variables: a) the endpoint being requested, and b) the country of the data being supplied. We’ve tried to keep things simple, so:
- A record from Canada, United States or United Kingdom sent to /address/verify will consume 2.5 credits.
- A record from all other countries sent to /address/verify will consume 10 credits.
- Selecting a record using /address/capture from the list of suggestions returned by the /address/complete endpoint will consume 8.75 credits (any country).
- Adding a geocode (digital latitude and longitude) adds a further 3 credits to the credits consumed for the record.
Our pricing chart offers a complete view of all credit charge combinations.
3. Using the API
Our API has been designed to offer integration into almost any website or application.
You may be looking to add post-checkout address verification to improve data quality and to aid fulfilment, or you may want to offer your web users the ability to auto-complete their address on your form. Even if you’re just looking to add location data to your customer base – we’re here.
Whatever the reason, our API supports various types of input (including partial, unstructured or single-field data) and returns a validated address using both component and formatted (address line) fields.
If you’re building in HTML/jQuery, we have sample code to help you set up your first call.
We love a challenge, so if you have a unique requirement or specific scenario that we’ve not covered here, please get in touch!
4. What is an AVC?
This stands for Address Verification Code and it gets returned with every process result. It lets you know two very important things.
Before we explain, here’s a quick introduction to the levels, which is something we’ll reference when walking through the code:
5 – Delivery Point (more granular than a house or building, such as an apt, flat, or ste)
4 – Premise (a house number or building name)
3 – Thoroughfare (refers to street)
2 – Locality (this is usually a city or town)
1 – Administrative Area (could be state, region, or an arrondissement in France!)
Here’s a level 5 address:
300 Berry St Unit 508 San Francisco CA 94158-1662 United States
All clear so far?
The first part of the AVC (V44-I44) lets you know what level an output address is.
The second part (V44-I44) is the parsing level, which reports the level that the address has been standardized to. A higher number means that some of the returned address is standardized but not validated.
Here’s an example. The output of a verification request is:
999 Baker Way Ste 8008 San Mateo CA 94404 United States
V44 says that the address is valid to Premise level. I55 lets you know that the address includes Delivery Point data, but it’s not verified. It doesn’t mean it’s not valid, but our data couldn’t find a match. By offering this level of analysis, you can configure your application to include or omit the non-verified components of the result.
5. Need more credit?
We offer credits in two ways.
- Monthly subscription. Perfect for regular daily or weekly usage. Each month you get a bucket of credit that is only valid in that month. Credits don’t roll over. There’s no minimum term.
- On-demand subscription. Better for project-based work or if you want to back up a subscription plan. Credits in these pack cost a little more, but you can consume them over the course of 12 months. You can purchase/queue multiple on-demand packs, plus we’ll soon be launching the ability to reload packs.
Our pricing page gives a breakdown of all packs and plans. We entrust Stripe to securely handle all of our credit card payments and subscriptions.
If you have any questions or need some help, we’re on standby! Good luck – and we hope you enjoy your trial!