Postman Collection

Postman is a popular tool used to test HTTP Requests to API endpoints. User Experience Insight offers a Postman collection that you can use to test REST APIs that are available here.

📘

Postman Definitions

• A collection is a set of API endpoints or requests, along with each endpoint's authorization type, parameters, headers, request bodies, tests, and settings grouped together.
• A environment is a set of one or more variables that you can reference when sending requests or writing test script in Postman.

This guides walks you through setting up Postman to make API calls using our Postman collection. It provides two options for setting up authentication:

1. If you already have an access token, you can paste it directly into the Postman Environment and proceed
2. If you don't have an access token, you can generate one using the Generate Access Token API in the Postman collection

Forking the Postman Collection & Environment

To begin, fork the Postman collection & environment into your workspace:

1. Go to the HPE Aruba Networking UXI Workspace. You can do this from the Postman website or application, which can be installed from here.
2. Within the workspace, click on the HPE Aruba Networking UXI Configuration collection which is pinned on the workspace's overview page. This will take you to the HPE Aruba Networking UXI Configuration collection.
3. Fork the HPE Aruba Networking UXI Configuration collection to your personal Postman workspace. This will enable you to make API requests to HPE Aruba Networking UXI using this Postman collection.

This ensures you have your own customizable copy of the collection & environment

Setting up the Variables

1. In your collection, go to the Variables tab
2. Configure the following variables in this tab
   1. access_token - Access Token is required to securely make an API Request to UXI API Gateway. If you already have an access token, paste it here. This will allow you to skip token generation & make API calls immediately. You can find
   2. client_id and client_secret - Leave these blank if you've provided a token. If you don't have an access token, enter your API client credentials for UXI to generate one.
      You can find steps to create API client credentials and/or generate access tokens here.

Generating an Access Token (If needed)

If you don't have an access token, follow these steps to generate one:

1. Open the Generate Access Token API within the Authentication folder in the Postman Collection
2. Verify that client_id, and client_secret are set in the active environment.
3. Execute the request by clicking on Send
4. Upon success, the generated access token will automatically be stored in the access_token variable in the environment

This API method eliminates the need to manually copy & paste tokens between applications, making it easy for you to build automation workflows within Postman

Making API Calls

To make API calls to UXI from Postman:

1. Ensure that the access_token variable is set.
2. Select the desired API request from the collection.
3. Configure any API parameters if required.
4. Click Send to execute the API request