Before setting up Postman, a Client ID and Secret to access the API are required. Contact the Cube Support team to receive this information if you still need to get it.
Using Postman To Retrieve An Access Token
- Create a new Collection and go to the Authorization tab
-
Select OAuth 2.0 for Type
-
Select Request Headers for Add auth data to
-
Set the Token Name to something recognizable such as Cube API
-
Select Authorization Code (With PKCE) for Grant Type
-
Select Authorize using browser
- Set the Auth URL to https://portal.cubesoftware.com/o/authorize/
-
Set the Access Token URL to https://api.cubesoftware.com/o/token/
-
Set the Client ID and Secret to the values from the Cube Support team in the steps above
-
Set the Scope to read write
-
Click Get New Access Token
You'll be redirected to the Cube web portal 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
Once you are authenticated with the API you will be able to make requests to Cube's endpoint.
- In the Authorization tab set the Type to "Inherit auth from parent"
- Ensure an Accept header is configured with a value of "application/json; version=1.0"
- The version may differ depending on which endpoint is being accessed
Further information about Cube's API can be found in our API docs.
Having issues? Contact our Support team at support@cubesoftware.com!