Skip to main content
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. If you haven’t yet, be sure to apply first.
Once your request is approved, we’ll send you an invitation to access the Enterprise Portal and the Postman Partners Workspace, so you can generate your client credentials and start interacting with our APIs. Start by accepting the Postman invitation. You will be added to the workspace as a Viewer.
Postman Invitation
Once inside the workspace, locate the REST APIs collection. It contains ready-to-use requests and examples of typical error responses.
To make API requests, you must select an appropriate environment:
  • Mock Server for static examples.
  • Sandbox to interact with a live testing environment.
  • Production to perform real transactions on live data.

​
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 use the Sandbox environment, you’ll need to configure your client credentials in Postman. First, generate your clientId and clientSecret from the Enterprise Portal.
Then, set the clientId and clientSecret as environment variables in Postman.

​
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.