POST v1/accesstoken


Documentation/Notes

Successful authentication yields a token that must then be passed to all subsequent API calls for the specified version. This token is one-time use and expires after 5 minutes of inactivity. To obtain this the ApiKey, UserName, and Password, an authorized customer contact must request one from their implementation specialist or account manager.


Request Information


URI Parameters

None.


Body Parameters

TokenRequestModel
NameDescriptionTypeAdditional information
ApiKey

Authrozied UserName

string

Required

UserName

Authrozied UserName

string

Required

Password

Authroized password

string

Required


Request Formats

application/json, text/json

Sample:
{
  "apiKey": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3"
}

application/xml, text/xml

Sample:
<TokenRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.V1">
  <ApiKey>sample string 1</ApiKey>
  <Password>sample string 3</Password>
  <UserName>sample string 2</UserName>
</TokenRequestModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TokenRequestModel'.


Response Information

Resource Description

AuthorizationTokenModel
NameDescriptionTypeAdditional information
Token

Token value that is one-time use and expires after 5 minutes of inactivity. This token must be captured for subsequent calls to the API.

string

None.


Response Formats

application/json, text/json

Sample:
{
  "token": "sample string 1"
}

application/xml, text/xml

Sample:
<AuthorizationTokenModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.V1">
  <Token>sample string 1</Token>
</AuthorizationTokenModel>