Set Up your Development Environment

Prerequisites

Verify the following items are properly installed and configured:

• Nuix RESTful Service
• Nuix Licensing, using either:
  • Nuix Management Server (NMS)
  • Nuix Cloud License Server (CLS)
• Any tool capable of performing HTTP(s) requests

You must know the following details about your installation:

• The server location of your REST installation.
  • Default location: <localhost>:8080/nuix-restful-service/svc/
    • Note: This URL is used throughout the provided examples to make calls to the API.
• The location of the API reference documentation.
  • Default location: <localhost>:8080/nuix-restful-service/svc/docs

Postman

Download and install

To download and install Postman:

1. Go to https://www.postman.com/downloads/.
2. Download the API client for your operating system.
3. After download is complete, run the installer on your computer.

• Note: For details on the installation process, see the Postman documentation.

4. After installation is complete, launch Postman.

Import the OpenAPI Specification

The Nuix RESTful Service API documentation can be imported directly into Postman using any of the following methods. The steps outlined below are based on Postman version 7.36.4.

Option 1: Run in Postman

To get started quickly, click the Run in Postman button below and follow the prompts to import the complete API directly into Postman.

Option 2: Link Import

To import the Nuix RESTful Service API into Postman using a link to the API specification:

1. Navigate to the Nuix RESTful Service reference documentation to locate a direct link to the OpenAPI specification.

   Default docs location: <localhost>:8080/nuix-restful-service/svc/docs

2. Right-click the URL below the heading at the top of the page, then select Copy link address to copy the location of the openapi-docs.json specification file.

   

3. Within Postman, expand the File menu, and then click import.

4. From the Import window, select the Link tab. Paste the address you copied in Step 2 into the URL field, and then click Continue.

5. Confirm the details of the import and make the following additional selections:

   • Under the Link this collection as menu, select Integration Test.
   • Click Show advanced settings and confirm the following selections:

6. Click Import.

When the import is complete, a new collection named Nuix REST-API Reference will be available from the Collections tab. The available endpoints are organized according to how they are listed in the API reference documentation.

Option 3: File Import

You should use this option if you do not have a running instance of Nuix RESTful Service, but have previously downloaded the specification in either openapi.yaml or openapi-docs.json format.

To upload the API documentation directly into Postman with the specification that you previously saved:

1. Within Postman, expand the file menu, and then click Import.

2. From the File tab, click Upload Files and then locate and select a previously downloaded API documentation file. (openapi.yaml or openapi-docs.json)

3. Confirm the details of the import and make the following additional selections:

   • Under the Link this collection as menu, select Integration Test.
   • Click Show advanced settings and confirm the following selections:

4. Click Import.

When the import is complete, a new collection named Nuix REST-API Reference will be available from the Collections tab. The available endpoints are organized according to how they are listed in the API reference documentation.

Advanced Postman Setup

Postman provides an interface that lets you create and test calls to an API. Postman also lets you configure variables for commonly used parameters that can be used to streamline your workflow when constructing API calls.

This section shows you how to set up some basic Postman configurations when you create a collection and save a request to it.

Create a Collection

1. Open Postman.
2. Select an existing collection or click on New Collection to create a location to save any API calls that you create for the Nuix RESTful Service.
   • Provide a name for the new collection and optionally a description.
3. Select the Variables tab and define the following variables based on your installation:

4. Click Create to finalize the new collection.

   

The newly created collection will be displayed in the left sidebar of Postman under the Collections tab. As you create and test calls to the REST API, you can save them to your newly created collection and access them from this location within Postman.

Create and save a request

Prerequisites

• Complete the steps under Create a Collection.

To create, then save a new request:

1. Click the + button located at the top of the builder window.

   

2. Expand the Save button drop-down menu next to the URL input field and select Save As from the menu.

3. Provide a Request name, such as Server Status, for the call.

4. Select the Collection to save the request in, then click Save.