How to generate a Token and authorize web documentation client to browse

Owned by JM Lopez
Last updated: Feb 21, 2019
1 min read

The new documentation interface provides you with ITS Private Cloud API endpoint requirements, sample JSON, request and payload parameters, and example of response messages and possible errors. The following steps will guide you through the process of generating an Access Token and authorizing the UI to make requests to the API on your behalf.

Step-by-step guide

  1. Go to the following link.
  2. Click on the Authorize button and type your VSS username and password in the first section Basic authentication. Click on Authorize.

  3. Click on the Token section and expand resources available.
  4. Expand the /auth/request/token resource to request a new access token for further requests to the API. Scroll down and click on Try it out. 
  5. In the response body, select and copy the value of the token attribute.
  6. Click on the Authorize button at the top of the page and fill out the value with the Access token previously generated as follows: 
  7. At this point please validate the authorization settings by trying out any of available resources. If successful, a 200 response status is expected.