This guide provides a step-by-step walkthrough for setting up Postman and accessing the Enterprise API Suite. By following these instructions, you can quickly start exploring and integrating with the API.

Note that this guide is for partners who have already initiated onboarding via our request form. If you haven’t yet, be sure to apply first.

Once your request is approved, we’ll send you an invitation to access the Postman Partners Workspace, a demo, an onboarding guide, and your client credentials, so you can interact with our APIs.

Start by accepting the Postman invitation. You will be added to the workspace as a Viewer.

Once inside the workspace, locate the Core API collection. This collection contains pre-configured API requests, allowing you to interact with various endpoints and assess possible errors.

To make API requests, you must select an appropriate environment. Choose a Mock Server for static examples or Sandbox to interact with a live testing environment.

​
Setting Up Mock Server

The Mock Server requires authentication. To generate an API key:

  1. Open User Settings in Postman.
  2. Navigate to the API Keys section.
  3. Click Generate API Key.
  4. Copy the generated API Key and set it as the value for x-api-key in the Mock Server environment.

​
Setting Up Sandbox

To make requests to the Sandbox environment, you must configure the clientCredentialsBase64 environment variable, with the result of encoding <clientId>:<clientSecret> into base64.

​
Next Steps

Once set up, you can start making API requests and exploring the available endpoints. Refer to the REST APIs for detailed request structures and response formats.