Postman is a collaboration platform for API development. Postman's features simplify each step of building an API and streamline collaboration so you can create better APIs—faster.

Authenticating

Postman uses API Key based auth, a developer-friendly delegated access protocol. Quolum has already connected the necessary wires with Postman. Using a sequence of click-throughs, your organization's administrator allows Quolum to make API calls to Postman without getting access to passwords.

Step 1: Initiate a connection to Postman

Click the Connect button from the Connections card. If you are not an admin, you can invite your organization's Postman admin to make a connection to your Postman organization account. When you click on the Connect button, the web browser will navigate to the Postman login page.

1027

Quolum Catalog: Postman App

Step 2: Log in to Postman

Log in to Postman using your organization's credentials. The exact login mechanism may depend on your Postman plan, and the sign-in mechanism used. You may have corporate SSO such as Azure AD, GSuite, or Okta along with multi-factor authentication. Once you have successfully logged-in you can find the API Key and API Secret as mentioned below in Step 3.

402

Postman Authentication

Step 3: Back to Quolum

Once you have granted access to Quolum, Postman is going to send you back to Quolum's page in Step 1, where you started. The Connect button on the Connections card would now say Reconnect. Reconnect is used to reauthenticate under circumstances where the access has expired.

Under the hood

Using the OAuth protocol, Quolum now has delegated access to your Postman Workspace. The Quolum server, running on Amazon AWS VPC, will be able to make API calls and retrieve feature-level utilization. Later, this data is crunched and available for visualization on the Quolum dashboard.

Important Note

API limitations with Postman integration:

  • The user list will only provide user ids. Quolum does not have access to get the user name or email. To find out a particular id belongs to which user, go to your Postman home page(Just login into Postman on the web). The URL is of the form https://.postman.co. Then append /users/ at the end of the previous URL. For eg: https://.postman.co/users/. This user-id is the user-id that is displayed on the Quolum dashboard. Alternatively, the admin of Postman can go and find out which id belongs to which user from the Postman admin page
  • If you are not on an enterprise plan, the number of users paid for by the organization can differ from the number of users listed on the Quolum portal if those users have not utilized the tracked features.