Smarty
Common Mistakes When Calling Smarty APIsWEBINAR RECAP: Recently, our Support Team Lead, Lyle Durland went over common mistakes and outlined what you need to know to avoid API problems.
Andrew Townsend
Andrew Townsend
 • 
July 28, 2022
Tags

There are two types of frequent errors: 401 "Authentication Required" errors, and 402 "Payment Required" errors.

Status Code 401 - Authentication Required

If you're seeing this error there's a chance that there's an issue with your API key, there's a mistake inside your client-side request, or a mistake in the server-side request. In the recording Lyle dives deep into each of these, but here are the basics.

How to Authenticate API Requests

It is important that you are familiar with your API keys. Inside your Smarty account there's an API Keys tab where you can find embedded keys, as well as secret keys. Knowing which keys are used in which environment will help you avoid some errors. If you don't have access to the Smarty account, it may be a good idea to contact the account owner and get access to it.

Understand the difference between client-side requests (in a web browser) and server-side requests. Since browsers send a Referer header automatically, our system treats any request that includes a Referer header as a client-side request. In contrast, if the request does NOT have a Referer header, our system treats it as a server-side request.

Common Mistakes in Client-Side Requests

For client-side requests you'll want to use the embedded keys, not the secret keys. To do so will return a 401 error. Also, don't list the wrong referer/host value with the embedded key. There are a few specific places where your host will be a little different.

  • For localhost, just list "localhost" without the port number.
  • For calls from the jsfiddle website, the correct host is fiddle.jshell.net

When using a wildcard in a hostname, don't use the * for more than one level of subdomain, or you will get the 401 error.

And lastly don't forget to URL-encode the request URL. For example, a # symbol that is not URL-coded will break up the request URL and return an error.

Common Mistakes in Server-Side Requests

For server-side requests you'll want to use the secret keys, not the embedded keys. Don't type the auth-id or auth-token by hand; you might mistype a 1 for a lower-case L or a 0 for a capital O. And of course, don't forget to URL-encode the request URL.

Status Code 402 - Payment Required

Most of these errors stem from a misunderstanding of the way Smarty's products work, or what each license provides you with. There are a few things you can do to avoid these errors.

If you are a developer trying to work with the Smarty APIs we recommend that you be able to log in to the Smarty account that you are trying to use. If you are not the primary account owner, you'll need to obtain those login details from whoever is.

It is beneficial to be familiar with the different pages available in your account dashboard such as Subscriptions and API Keys pages. Knowing what you have available in the Subscriptions section will help you identify the APIs you are allowed to call and what specific abilities are included. If you are ever unclear you can contact the Smarty Support team on any of Smarty's pages via the chat, email, or phone call.

If you have several accounts with licenses make sure you're using the correct APIs from the correct accounts. Several of our customers are contractors or independent users who are utilizing several accounts. That may be the first thing you want to check if that is the case.

If you are using one of our SDKs don't assume that the elicense value listed in the Github example code is the right one. For example, the default license listed in the Github example code is us-rooftop-geocoding-cloud, but you may not have a Rooftop Geocoding license.

When in Doubt, Contact Support

The Smarty Support team is here for you. Feel free to contact them any time you need it!

Regular office hours: Weekdays 8 AM - 5 PM Mountain Time.

Phone: 801-877-5778

Chat: Anywhere on smarty.com

Email: support@smarty.com

Watch the full webinar recording for more information!

Subscribe to our blog!
Learn more about RSS feeds here.
rss feed iconSubscribe Now
Read our recent posts
Smarty Launches US GeoReference Data, Providing the Easiest, Most Accurate API Needed To Access Census Tract and Block
Arrow Icon
PROVO, Utah, April 10, 2024 – Smarty, the address data intelligence leader, announces today the launch of US GeoReference Data, a set of updates to Smarty's US Address Enrichment solutions. US GeoReference Data is a cloud-native solution that will allow organizations to append the geographic data found in U. S. Census Block and Tract information into accurately geocoded addresses.  Smarty's US GeoReference Data is the simplest and fastest way for organizations to access Census Blocks, Tracts, location names and statuses, as well as additional Census ID information relevant to a property.
International Be Kind to Lawyers Day
Arrow Icon
Lawyers get a bad rap. Lawyers have been around for a long time, and when you're this old, you're bound to collect your fair share of good and bad. It's true, ask your grandpa. We've got records of people described as "lawyers" going back to ancient Greece, Rome, and the Byzantines. These first individuals were folks who were asked to speak for the accused because those under scrutiny were—understandably so—shaken up by the situation. It went from someone who was your friend and did you a favor by speaking on your behalf to someone who knew all of the laws, and you'd hire them to speak eloquently for you.
Navigating the Future: Geocoding & Address Data Trends in the Cloud
Arrow Icon
In a recent webinar, Berk Charlton, Chief Product Officer at Smarty, provided an in-depth look at our industry-leading address intelligence suite designed to provide highly accurate geocoding and address validation. Here are the main points Berk covered during the session:Comprehensive Product Suite: Smarty offers a wide range of products, including address validation, rooftop geocoding, global address auto-complete, and address data enrichment. These tools are designed to handle various aspects of address management and enhancement in industries from Insurance to Healthcare to Telecom and more.
Ready to get started?