POST api/Authenticate
Authenticate API user and generate authorization token
Request Information
URI Parameters
None.
Body Parameters
The API user input parameters
AuthenticatePostParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| username |
Subscription username which provides access to this API |
string |
None. |
| password |
Subscription password which provides access to this API |
string |
None. |
| grant_type |
The access grant type |
string |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
username=sample string 1&password=sample string 2&grant_type=sample string 3
Response Information
Resource Description
AuthToken| Name | Description | Type | Additional information |
|---|---|---|---|
| token_type |
Type of token, e.g. bearer |
string |
None. |
| expires_in |
The amount of seconds to token expiration |
integer |
None. |
| access_token |
Token to be used to authorize each API request |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"token_type": "sample string 1",
"expires_in": 2,
"access_token": "sample string 3"
}