REST Client Prerequisites

Any application that interacts with the REST API needs to send HTTP requests and receive HTTP responses. The request and response body may be either XML or JSON.

For example, the following XML is sent when authenticating:

<?xml version="1.0" encoding="UTF-8"?>
<session>
    <userName>admin</userName>
    <password>passphrase</password>
</session>

If using JSON, the following is incorrect:

{
  "session": {
    "userName": "admin",
    "password": "NextGen"
  }
}

The correct JSON request has the root element removed:

{
  "userName": "admin",
  "password": "NextGen"
}

Step 1: Obtain NNC User Information

Obtain the user name and password credentials from your account administrator to enable you to initiate a session with the REST API through the login URI.

Step 2: Install and Configure the REST Sample Client

The following task shows how to install and configure the REST sample client on which you can view the structure and composition of the REST API in order to help you construct your own REST client.