Setup Postman with the Cube API

Before setting up Postman, a Client ID and Secret to access the API are required. Contact your Account Manager to discuss pricing and next steps.  Once you have the necessary details, you can follow the steps below: 

Using Postman To Retrieve An Access Token

1. Create a new Collection and go to the Authorization tab
2. Select OAuth 2.0 for Type
3. Select Request Headers for Add auth data to
4. Set the Token Name to something recognizable such as Cube API
5. Select Authorization Code (With PKCE) for Grant Type
6. Set the Callback URL to https://oauth.pstmn.io/v1/callback
7. Select Authorize using browser
8. Set the Auth URL to https://portal.cubesoftware.com/o/authorize/
9. Set the Access Token URL to https://api.cubesoftware.com/o/token/
10. Set the Client ID and Secret to the values from the Cube Support team in the steps above
11. Set the Scope to read write
12. Click Get New Access Token

You'll be redirected to the Cube Workspace and shown a login window if appropriately configured.

Upon successful login, you will see a confirmation screen from Postman with your access token and the ability to refresh it:

Using Postman To Make An API Request

After you are authenticated with the API you will be able to make requests to Cube's endpoint.

1. In the Authorization tab set the Type to "Inherit auth from parent"
2. In the Headers tab
   • Ensure an Accept header is configured with a value of "application/json; version=1.0" 
     Note: The version may differ depending on which endpoint is being accessed
   • Set the X-Company-ID to your Company ID. 
     Note: Your Company ID can be provided by our support team. 

Further information about Cube's API can be found in our API docs.

Having issues? Contact our Support team at support@cubesoftware.com!