Web API: Token: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
The Token operation is used to login a user | The Token operation is used to login a user. The '''access token''' is returned as a response, which is used to identify the session in the subsequent Web API operations. | ||
<pre> | <pre> | ||
| Line 8: | Line 8: | ||
</pre> | </pre> | ||
Note that the path doesn't contain '''api''' unlike all other operations in the Web API. | Note that the path doesn't contain '''api''' unlike all other operations in the Web API. Example url: | ||
<pre> | |||
https://customer.onqpr.com/qprpa/token | |||
</pre> | |||
Request body contains the following parameters as url encoded: | Request body contains the following parameters as url encoded: | ||
Revision as of 14:45, 18 May 2020
The Token operation is used to login a user. The access token is returned as a response, which is used to identify the session in the subsequent Web API operations.
Url: POST /token Content-Type: application/x-www-form-urlencoded Body: username=myUserName&password=myPassword&grant_type=password
Note that the path doesn't contain api unlike all other operations in the Web API. Example url:
https://customer.onqpr.com/qprpa/token
Request body contains the following parameters as url encoded:
- username: Login name of the user
- password: User password
- grant_type: password (always use that value)
The response is a JSON object with several properties, and one of them is access_token containing the access token (session id).