Using Postman with Navixy

Testing API with Postman

When working with API requests, developers have a wide range of tools at their disposal, from simple browser inputs to advanced software solutions. One of the preferred tools among developers is Postman, a robust platform for API development. Postman excels in various tasks, including simple request testing, API creation, and ongoing maintenance.

Navixy streamlines API integration by offering ready-made Postman collections. These collections allow developers to quickly import, test, and modify API requests without manual setup, enhancing efficiency and simplifying the process of interacting with Navixy's platform.

Navixy Postman Collections URL:

https://www.postman.com/navixyapisandbox

Navixy API Sandbox in Postman URL:

https://www.postman.com/navixyapisandbox/workspace/navixy-api-sandbox/overview

For this guide, we will focus on using Postman as an API client.

Getting Started with Postman

What is Postman?

Postman is a collaboration platform for API development, used by over 10 million developers worldwide. It simplifies the process of building, testing, and maintaining APIs, offering a user-friendly interface for sending requests and receiving responses.

Installing Postman

To get the latest version of the Postman app, visit the download page and click “Download” for your platform. Follow the installation instructions specific to your operating system.

Setting Up Postman

Open Postman: After installation, open the Postman application.
Create an Account: Sign up for a Postman account if you don't already have one. This will allow you to save your work and sync it across devices.
Import Navixy Collections: Use the link provided above to import the Navixy Postman collections into your workspace.

Your First Request

The Postman API client simplifies sending API requests and ensures that parameters are correctly formatted. This is particularly useful for handling complex or large requests.

Steps to Make Your First Request

Select a Request Method:
Select request method in Postman
Each API request uses an HTTP method. The most common methods for the Navixy API are GET and POST. GET retrieves data from the API, while POST sends new data.
Enter the Base Request URL with the Resource and Sub-resource:
In our example, we will use user/auth and tracker/list requests. Base request URLs are:
- For EU server - https://api.eu.navixy.com/v2/
- For US server - https://api.us.navixy.com/v2/
Enter URL
Click on the Params Button:
Enter params
Fill in the fields - Key (parameter name from documentation) and value. For the user/auth request, we have 2 keys that should be transmitted - login and password.
Once you fill out the parameter name, it is automatically added to the request line.
Enter params
Similarly, with values and additional parameters:
Enter params
Enter params
Press Send:
You will see the reply, already split and highlighted for easier reading:
Enter params
In this case, we have received a hash that should be copied and used for future requests.
Example: tracker/list request
Enter params

Managing Parameters

If your request has multiple parameters listed, you can easily enable and disable them to prevent errors:

Request History

Postman keeps a history of your requests on the left side of the application. You can revisit and re-execute previous requests with a simple double-click, opening them in a new tab:

Examples in Documentation

The Navixy API documentation includes both the structure of requests and examples. You can copy these examples into Postman, where parameters will be automatically parsed for convenient editing:

Importing cURL Examples into Postman

You can also import cURL examples from our documentation into Postman. Copy the cURL example, open the import tab in Postman, choose Raw Text, paste the example, and save it: