Web API: Token

From QPR ProcessAnalyzer Wiki
Revision as of 22:43, 15 May 2020 by Ollvihe (talk | contribs)
Jump to navigation Jump to search

The Token operation is used to login a user to start a session required by the Web API. The access token is get as a response which is used to authenticate other Web API operations.

Request

  • Request url has the following form: https://SERVER/qprpa/token, where SERVER is the DNS name of the server. Note that the path doesn't contain api unlike all other operations in the Web API.
  • Request method is POST.
  • Content-Type in the HTTP request header must be application/x-www-form-urlencoded.
  • Request body contains the following parameters as url encoded:
    • username: Username.
    • password: User password.
    • grant_type: password (always use that value)

Example:

username=myUserName&password=myPassword&grant_type=password

Response

The response is a JSON object with several properties. One of them is access_token containing the access token (session id).