Skip to main content

​
About Postman API Setup

Postman provides a user-friendly interface for testing and interacting with the Iru Endpoint API. This setup process configures Postman with the necessary collections, environment variables, and authentication to streamline your API workflows.

​
How It Works

The Iru Endpoint API uses standard REST principles with token-based authentication. Postman collections provide pre-configured requests for all available API endpoints, while environment variables securely store your authentication credentials and API URLs.

​
Prerequisites

  • Access to Iru Endpoint with API permissions
  • Postman application (free or paid version)
  • API token from Iru Endpoint

​
Set Up Postman for Iru Endpoint API

1

Configure Iru Endpoint API Token

To make any API requests, you’ll create an API Key that you’ll use whenever you interact with the API.
  1. Visit the Iru Endpoint API Overview article for instructions on creating your API Token
  2. Store the new API token in a secure location for use later
It’s possible to use other third-party API tools, but we have a Postman Collection available to import all of the current API commands for a quick setup.
2

Install Postman

If you already have Postman installed on your device, skip this step.
  1. Visit the Postman website to download the Postman app
  2. Copy the Postman.app to your Applications folder
  3. Launch the application
3

Configure Postman

If this is your first time launching Postman, you can Create a Free account, Sign in, or Skip and avoid signing into the app.
  • Check the Postman Preferences to adjust settings such as the Theme
4

Import Iru Endpoint API Collection

Follow these steps to easily import all available Iru Endpoint API requests into Postman.
When new Iru Endpoint API commands are added, you’ll need to import the Iru Endpoint API again to have these new commands available in the Collection.
  1. Visit api-docs.kandji.io and click the Run in Postman button at the top right of the page
  2. Select Postman for Mac
  3. Select Allow in the Do you want to allow this website to open “Postman.app”? prompt
This prompt may vary depending on which internet browser you’re using.
  1. Select the Workspace where the Collection should be added
  2. Select Import
5

Create Environment Variables

Creating environment variables allows you to store values such as your API token more securely and use the same variables across different Collections in Postman. You can read more about this in Postman’s Collections article.
  1. Click File
  2. Click New
  3. Select Environment
  4. Add the following variables to the Environment and set the type to Secret:
    • api_token, device_id, ade_token_id
    • At this time, define the value for api_token, and only define the others now if you have that information available
  5. Click Save
6

Set Environment

  1. Select the new Postman Environment following their guide
7

Define Iru Endpoint API Variables

  1. In the Collections Panel, click on Iru Endpoint API
  2. In the middle panel, click on the Variables tab
  3. Define the value for the API URL variable. To find your API URL:
    1. Navigate to Settings
    2. Click the Access tab
    3. Go down to the API Token section

​
Best Practices

  • Store credentials securely - Use Postman’s environment variables for sensitive information
  • Keep collections updated - Re-import the collection when new API endpoints are added
  • Test your setup - Run a simple API call to verify everything is configured correctly
  • Use descriptive names - Name your environments and collections clearly for easy identification

​
Considerations

  • Token security - Never share your API tokens or commit them to version control
  • Collection updates - You’ll need to re-import the collection when new API commands are added
  • Browser compatibility - The import process may vary slightly depending on your browser

​
Next Steps

You should now be ready to perform API commands. For more information about specific API commands, please review our API documentation.