How to Use the WP Umbrella API Postman Collection

This guide will walk you through setting up and using the WP Umbrella API in Postman. With this collection, you can test all available endpoints, making it easier to understand how each endpoint functions and what it returns.

Prerequisites

1. Postman

Install Postman if you haven’t already. It’s free and simplifies API testing and development.

1. WP Umbrella Postman Collection

Download or import the Postman Collection .json file you received. It includes organized endpoints for the WP Umbrella API.

WP Umbrella - Public API Documentation.postman_collection.json

1. API Credentials

Ensure you have an access token (accessToken) for authentication. If needed, reach out to your API administrator.

Step-by-Step Guide

1. Importing the Postman Collection

• Open Postman.
• Click Import in the top left, then select Upload Files to upload the .json file.
• Once imported, the WP Umbrella collection will appear in your sidebar, with folders organizing endpoints by type (e.g., Me, Projects, Vulnerabilities).

2. Setting Up Environment Variables

The collection includes variables like {{publicApiUrl}}, {{accessToken}}, and {{projectId}} to streamline requests. Set up an environment to handle these values globally.

• In Postman, go to Environments and create a new environment.
• Add the following variables:
  • publicApiUrl (default: https://public-api.wp-umbrella.com)
  • accessToken (use your API access token)
  • projectId (e.g., the ID of a project you wish to test with)