Working with REST Web Services Using Postman

In this document, the REST web services functionality is demonstrated using the Postman Application. However, you can use any similar tool of your preference to work with REST web services. Besides being able to build and send the API requests, the Postman Application also acts as a library for your requests which you can then import and export. You can download Postman at https://www.getpostman.com/

Installing Postman

Follow these steps to install Postman:

Download and install the Postman desktop application from https://www.getpostman.com/.

Note:
Do not use the (deprecated) Chrome extension, as it does not support some of the features that are present in the REST web services sample request collection.
Run Postman. Click Take me straight to the app on the initial splash screen.
Close the initial task window.

Note:

If you are using Postman version 10, you must create a user account to be able to send REST requests.

Working with Postman Environments and Collections

A Postman environment is a set of key-value pairs. The key represents the name of the variable. Using a Postman environment, you can switch between various NetSuite accounts, and between your test or production accounts. Using Postman environments, you can customize requests using variables so you can switch between different setups without changing your requests. You can also download environments, save them as JSON files, and upload them later.

A Postman collection is a set of HTTP requests. Similarly to the environments, you can create, share, duplicate, export, and delete a collection. You can also import a collection as a single JSON file. The collection distributed together with this document requires a proper environment setup as described in Importing and Setting Up a Postman Environment.

You can download the REST API Postman environment template and collection of sample requests from the SuiteTalk tools download page at https://<accountID>.app.netsuite.com/app/external/integration/integrationDownloadPage.nl. To access the page, you must substitute your account ID in the URL.

Note:

To access the Postman environment template and collection, the REST Web Services feature must be enabled, and you must have the REST web services permission assigned to your role. For more information, see REST Web Services Prerequisites and Setup.

The set of sample requests for the Postman Application is provided to demonstrate how to use the NetSuite REST web services. The sample requests can also help you start building your REST-based integration with NetSuite.

For more information, see the following topics:

Installing Postman

Working with Postman Environments and Collections

Related Topics