Naurt's Postman Collection; Step-by-Step Guide

Introduction

In this tutorial, we will discuss what Postman is and how to quickly get set up with it.

Postman is a desktop and web application that allows you to make requests to an API from a graphical user interface. We recommend using Postman with the Naurt-Final Destination when exploring the APIs functionality, as well as when you are troubleshooting issues with your application. Our official documentation is available at docu

We currently have one collection available as:

• Naurt v1

Prerequisites

Using Naurt services requires an API Key. If you don’t already have one, you can sign up to the  Naurt dashboard for free. All we require is a verified email and you'll be good to go  We don’t require a credit card. You’ll get a free key loaded with thousands of requests.

Getting Started With Naurt's Postman Collections

Step One: Add the Naurt Postman collections to your account

While you could build out the specific endpoints that you’d like to use within Postman, we did all of the heavy lifting for you and built out a ready to use collection of relevant APIs. Just click one of the links in the earlier “Postman collections” section and a collection with all of the endpoints associated with the selected API will be added to your Postman app. These collections are also available in the Postman API network. Each endpoint will automatically include available parameters, example responses, and authentication type plugged in, so you just need to add your API key and query to start exploring the functionality.

In this example, we are going to work with the Naurt v1 collection.

Step Two: Add your key

When you add the collection to your Postman instance, it will automatically have the required configurations needed for calling the Naurt APIs. In this step, we will walk you through the process of adding your key into the collection.

To add your keys to the collection, open the final destination folder and click on the Authorization tab, add your API Key in the value section. All requests will automatically inherit the same.

Next, about the target URL, which will get set by the pre-requisite script itself. So no environment details to be provided later.

Once you’ve added your API Key, you will be ready to make requests.

Step Three: Try a request

The next step is to choose from the collection and start to build your request. You can select from the right-hand side navigation. Here is what this looks like:

For this example, we are going to use the Final Destination > Geocoding API > Search with address request.

Step Four: Add search string in request body

Go ahead and try out your favourite spots (currently the API has coverage for UK, Singapore, and US). It should look like the following:

Step Five: Send your request and review your response

Now that everything is set up in your request, you can click the “Send” button.

If everything was set up properly, you should receive the response. (Here the content of the geojson is left out deliberately, as the resultant JSON is very large)

1{
2  "best_match": {
3    "address": "Byward Tower, The Tower Of London, Tower Hill, London, Greater London, England, United Kingdom, EC3N 4AB",
4    "geojson": {},
5    "id": "8733fb0c-083f-868a-5ce6-023562ced763"
6  },
7  "version": "1.1.7"
8}

More Examples

Naurt -final destination APIs supports many combinations of search possibilities. You can search with latitude and longitude values, add distance filters, enable additional results and much more. They are listed along with the requests as examples with responses too. Hit the Try button and see for yourself.

What's Next

If you click on the button in Postman that says "Code", you can turn the request we just created into the language of your choosing such as Python, Node or Ruby to help you get started. Postman has great documentation that might be helpful. We also have some sample code on GitHub that can help you get integrated with the endpoints more quickly. Our sample code has integrations for Go, Typescript, Python, Ruby, C# and much more..

Official documentation is available at Naurt Docs

Sandbox

Naurt's Sandbox, If you want to see the geojson in a map(geojson viewer) and play around a bit with different address or so, then checkout our Naurt Sandbox (its free again!!).

By pasting in your API key, you'll be able to forward search using addresses or, reverse search by clicking on the map with the results both plotted and displayed as a JSON.

Coverage

Naurt's Coverage is available in the following regions for now : (More to come..)

• UK: United Kingdom
• SG: Singapore
• US: United States

Refer to our documentation for full coverage details