POST api/Authenticate

This API method creates a session token which should be presented in all subsequent requests to the API. The session will stay alive for 20 minutes, the idle timer will renew after every request.

Request Information

URI Parameters

None.

Body Parameters

LoginChallenge
NameDescriptionTypeAdditional information
SystemInformation The branding name supplied to you by UST string

None.
UserName Your portal login user name string

None.
Password Your portal login password string

None.
SessionToken Leave this field empty string

None.

Request Formats

application/json, text/json

Sample: 
{
  "SystemInformation": "sample string 1",
  "UserName": "sample string 2",
  "Password": "sample string 3",
  "SessionToken": "sample string 4"
}

application/xml, text/xml

Sample: 
<LoginChallenge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <Password>sample string 3</Password>
  <SessionToken>sample string 4</SessionToken>
  <SystemInformation>sample string 1</SystemInformation>
  <UserName>sample string 2</UserName>
</LoginChallenge>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoginResponse
NameDescriptionTypeAdditional information
Token Session token that must be presented to the API globally unique identifier

None.

Response Formats

application/json, text/json

Sample: 
{
  "Token": "9fe2a221-8856-4662-88df-74dbe6f4ff18"
}

application/xml, text/xml

Sample: 
<LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <Token>9fe2a221-8856-4662-88df-74dbe6f4ff18</Token>
</LoginResponse>