Smarty Postman Collections

Welcome to Smarty, one of the fastest address verification and geocoding services available! This repository will help you familiarize yourself with the Smarty APIs. The following steps will guide you through creating a Smarty account and sending Smarty API requests using Postman.

Table of contents

• Getting started
  • Configuration

• Making Smarty API calls

Getting started

Follow these steps to get started with the Smarty APIs:

1. Sign up with Smarty to get a set of API keys that are required for interacting with the APIs. If you already have an account, log in with your credentials.
2. Click the "Run in Postman" button below. You will be directed to a new tab, then click the "Fork Collection" button. You will be required to create a free account with Postman.

3. If you do not want to fork the collection using the "Run in Postman" button, you can download the JSON files from the postman-download folder in this repository. You will need to import these into Postman.
4. Once the Smarty APIs collection and the Smarty environment are imported into Postman, see the Configuration section on how to configure API keys in the environment.

Configuration

The Smarty Postman collection uses Postman environment variables to provide authentication for each API request. These steps will help you set up the necessary environment variables to use the Smarty APIs.

1. Select the Smarty environment in the top right corner of Postman.
2. Click the eye icon to open the environment settings.
3. Open your Smarty account Dashboard.
4. Select the API Keys section on the left side of your Smarty Dashboard.

5. Copy your Smarty API secret key information into each "current value" field in the Smarty environment:

   • auth-id
   • auth-token

6. Save your changes in the environment and start making Smarty API requests!

Making Smarty API calls

Once you have completed the steps in the Configuration section above, you are ready to make API requests using Postman! Complete the following steps to make your first API request.

1. Select the "Collection" pane on the left side of Postman. Expand the "Smarty API" folder on the left and navigate to Smarty API -> US Street Address API -> Single Address.
2. In the pane on the right, which has the options "Params", "Authorization", "Headers" etc. click on the "Params" tab.
3. Update the "license" parameter value using the license value on your Smarty Dashboard subscriptions tab. Each license value is associated with different API requests. (insert information on what APIs use each license?)
4. (Optional) If you want, update the parameter values to match the address you would like to send to the API, such as street, city, etc.
5. Click the blue "Send" button on the right.
6. The response body should appear in Postman. If there was an error, an error message will show in the response body.
7. Continue trying Smarty APIs! Be aware that you will only have access to the APIs that use the subscription(s) that you currently have. You can sign up for free trials here.