Postman Collections
5 min
Postman Collections
Introduction
Postman Collections provide a convenient way to explore and test the Nue APIs. These collections contain pre-configured API requests that you can use to interact with Nue's services without having to manually set up each request.
Getting Started
Prerequisites
- Postman application installed on your computer
- A Nue account with API access
- Your Nue API key (see API Keys for more information)
Run in Postman
There are the following postman collections:
You can click the 'Run in Postman' button in the upper left corner of each collection page to import the API collection into your Postman workspace.
Setting Up Environment Variables
To use the collections effectively, you'll need to set up environment variables:
- Click on the "Environments" tab in Postman.
- Create a new environment (e.g., "Nue API").
- Add the following variables:
- endpoint: The base URL for the Nue API
- nue-api-key: Your Nue API key
- Select your environment from the dropdown in the top right corner of Postman.
Authentication
All requests in the collections are pre-configured to use API key authentication. The collections use the {{nue-api-key}} variable from your environment.
Each request includes the necessary authentication header:
NUE-API-KEY: {{nue-api-key}}