Skip to main content

How to navigate Postman documentation

Postman is your ultimate companion for exploring and mastering APIs, and the Indigo X API documentation is designed to make your journey seamless. Whether you're launching browser profiles, managing proxies, or automating scripts, this guide will walk you through navigating the Postman documentation like a pro.

Getting Started with the Left Sidebar​

The left sidebar is your gateway to the Indigo X API. It organizes all endpoints into intuitive folders based on their utilities, making it easy to find the tools you need.

Left Sidebar Overview

Key Folders in the Sidebar
  • Launcher: Start/stop normal and quick browser profiles, retrieve profile metadata, and more.
  • Profile Access Management: Control access to profiles, folders, and API tokens.
  • Profile Management: Create, search, update, or delete profiles.
  • Browser Profile Data: Manage data to ensure smooth browser profile operations.
  • Pre-made Cookies: Collect reliable cookies for a trustworthy browsing history.
  • Script Runner: Run automation scripts with minimal setup.
  • Profile Import/Export: Import or export profiles from your machine.

Collapse folders to keep your workspace tidy, and start with the Indigo X API Overview folder for a quick onboarding guide.

Pro Tip

Check for v2 vs. v3 labels in endpoint descriptions to avoid using deprecated versions.

Exploring Endpoint Contents​

Each endpoint in the documentation is like a detailed instruction card, providing everything you need to make successful API requests. When you click an endpoint, you’ll find:

  • Method Type: Indicates the action (e.g., GET, POST, PUT, DELETE).
  • Endpoint Path: The specific URL path for the request.
  • Parameters:
    • Headers: Include details like your authorization token.
    • Query Params: Optional URL parameters for customization.
    • Path Variables: Dynamic parts of the URL that you can swap out.
  • Example Request Body: A sample structure for POST or PUT requests.
  • Example JSON Bodies: Templates for expected response data.
Avoid Errors

Stick to the example request structure to minimize mistakes. Copy the sample JSON and tweak headers as needed.

Leveraging Example Requests and Responses​

Most endpoints include Example Request and Example Response sections, typically located at the bottom or right side. These are your shortcuts to success:

  • Copy and Paste: Use the examples directly in Postman to avoid writing code from scratch.
  • Debugging Aid: Perfect for troubleshooting errors or building request sequences.
  • Language Flexibility: Switch between coding languages using the top bar dropdown.
  • JSON Responses: Responses are automatically formatted in JSON for clarity.

Example Request and Response

Customizing Your Experience with the Top Bar​

The top bar lets you tailor the documentation to your preferences, offering visualization styles and technical settings.

Visualization Styles​

The Layout Menu lets you choose how content is displayed:

Endpoint contents and examples are arranged vertically for a streamlined view.

Language and Engine Settings​

  • Language Menu: Select your preferred coding language for example requests.
  • Engine Icon: Fine-tune how requests are displayed and behave:
    • Adjust indentation count and type.
    • Trim unnecessary details or "prettify" code.
    • Set request timeout limits or enable HTTP follow redirects.

Running Endpoints in Postman​

The Run in Postman button, located on the far right of the top bar, lets you import endpoints directly into your Postman workspace.

Steps to Run in Postman​

  1. Click Run in Postman.
  2. Download and install Postman for your operating system (select Postman for <your OS>).
  3. In Postman, go to Import Collection and choose the Indigo X API collection folder.
  4. Click Import to add it to your workspace.
  5. Set up your local Postman environment.

Once imported, the collection mirrors the documentation in your Postman workspace, ready for testing and experimentation.

Example Request and Response

Workspace Tip

Your imported collection should look identical to the documentation, neatly organized and ready to use.

Best Practices for Navigating the Documentation​

To make the most of the Postman documentation:

  • Stay Organized: Collapse folders in the sidebar to reduce clutter.
  • Start with the Overview: The Indigo X API folder provides a high-level guide.
  • Follow Examples: Use the provided request/response templates to save time.
  • Check Versions: Look for v2 vs. v3 indicators to ensure you're using the latest endpoints.
  • Experiment Safely: Test endpoints in Postman’s sandbox environment before integrating into production.

Ready to Dive In?​

The Indigo X API documentation, paired with Postman, is your key to unlocking powerful API workflows. From managing browser profiles to automating scripts, the intuitive structure and rich examples make it easy to get started and scale up.

Explore the documentation, import the collection into Postman, and start building today!

Need Help?

Visit the Indigo X API documentation or contact support for assistance.