API Documentation
/
No Results Found
API Collection

What is an API Collection?

The ADManager Plus REST API Postman collection is a ready-made set of all API requests, designed to help you quickly explore, test, and understand how the APIs work. Instead of spending time manually setting up environments, variables, and authentication for every call, you can simply fork the collection and start experimenting right away.

This collection comes with boilerplate requests for every endpoint, making it easier to:

  • Test API calls without writing code from scratch.
  • Explore how requests and responses work across different environments and organizations.
  • Reuse pre-configured requests to accelerate development and reduce setup errors.

To get started, simply click the button below and fork the official ADManager Plus Postman collection:

Run in Postman

Why use the API collection?

Setting up API calls one by one can be repetitive and error-prone. You would normally have to configure environments, variables, and authentication headers manually. The Postman collection eliminates these steps by:

  • Simplifying setup: Variables and headers are pre-defined
  • Speeding up testing: Start testing endpoints in minutes
  • Reducing errors: Prevents mistakes in parameters or authentication
Note:
The Postman collection is meant to simplify testing and exploration. It does not replace the official ADManager Plus API documentation. For accurate implementation, always use both together.

Prerequisite

Before using the Postman collection, ensure you have:

Using the ADManager Plus REST API collection

Follow these steps to start testing APIs with the Postman collection:

Step 1: Install Postman

Download and install the Postman app (desktop version recommended). You can skip this step if you have already installed the Postman app in your system. The preferred version is Postman v8.

Step 2: Download the collection

Download the ADManager Plus REST API Postman collection file from the official source.

Step 3: Import the collection

  1. Open Postman.
  2. Navigate to the Collections tab in the top-left corner.
  3. Click Import and select the downloaded ADManager Plus collection file.
  4. A new collection named <collection_name> will now appear.

Step 4: Configure variables and invoke APIs

  1. Click the imported collection and open the Variables tab.
  2. Update the following environment variables with their corresponding values:
    • protocol: The protocol used by your ADManager Plus instance (e.g., http or https).
    • host: The hostname or IP address where ADManager Plus is running.
    • port: The port number on which ADManager Plus is accessible (default is usually 8080).
    • authtoken: Authentication token generated from ADManager Plus.
    • api_version: Version of the REST API to be invoked (e.g., v2) .
  1. Save the variables.
  2. Select any request from the collection and click Send to test.

With this setup, you now have a fully configured environment where you can run ADManager Plus API requests instantly. The boilerplate requests are ready to use —just plug in your variables and go.