Postman is a popular tool with our customers for interacting with APIs. This article will help you to configure Postman to use the Workspot Control API.
Prerequisites
Administrative access to Workspot Control.
Workspot API feature should be enabled.
Configure Postman
Create a free Postman account at https://www.postman.com/postman-account/ if you don’t have one already.
Login to Postman https://web.postman.co/
Go to “My Workspace”:
Click on “Collections” from the left pane and click on “+” to Create a new collection.
Select “Blank Collection” and give the new collection a name, such as “Workspot”:
Click on “…” and then “Add request,” and give a name to the request, such as “LicenseInfo.”
On the right side a section will open with Params, Authorization Headers, and other Tabs. Click on the Authorization tab and select OAuth2.0:
Go to the Configure New Token section and provide the required details:
Enter a convenient name in the Token Name field
Select “Grant Type” as “Password Credentials”
Set the “Access Token URL”
For US Control: https://api.us.workspot.com/oauth/token or https://api.workspot.com/oauth/token
For EU Control: https://api.eu.workspot.com/oauth/token
Set the “Client ID” and “Client Secret” (click the “Reveal” button to show the full Client Secret) under Control’s Setup > API” page.
Enter the username (Workspot Control administrator email) and the password of the Administrator.
Keep the “Scope” field blank and Client authentication to “Send as Basic Auth header”.
Click “Get New Access Token.”
Click “Use Token.”
Note: The token will remain valid for 60 minutes, after which you need to click “Get New Access Token” and “Use Token” again.
Example of Using the Workspot Control API
In a browser, go to the Workspot Control API:
https://api.eu.workspot.com:443 for customers with Control deployments in the EU region.
https://api.us.workspot.com:443 for customers with Control deployments in the US region.
From the Control API, capture the appropriate commands to paste into Postman:
Click on “api-controller” to see the list of API commands:
To get the request URL, Click “Try Out” and then “Execute.”
Copy the Request URL, paste it into the Postman, and click on Send.
Postman will send the request with the appropriate credentials for your Workspot deployment
The API will send the response, which will be displayed in the Body section as shown below:
