POST 1.0/customermanagement/auth

Description

Authorises a user to access the Customer Managment system, this does not perform a captcha check should be used internally

URI Parameters

None.

AuthorisationDetails
Name Description Type Additional information
ResellerID

integer

None.
Password

string

None.
AuthToken

string

None.
Email

string

None.
ReCaptchaToken

string

None.
SecretKey

string

None.

application/json, text/json
Sample: 
{
  "resellerID": 1,
  "password": "sample string 2",
  "authToken": "sample string 3",
  "email": "sample string 4",
  "reCaptchaToken": "sample string 5",
  "secretKey": "sample string 6"
}

application/xml, text/xml
Sample: 
<AuthorisationDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ReCaptchaToken>sample string 5</ReCaptchaToken>
  <SecretKey>sample string 6</SecretKey>
  <Email>sample string 4</Email>
  <Password>sample string 2</Password>
  <AuthToken>sample string 3</AuthToken>
  <ResellerID>1</ResellerID>
</AuthorisationDetails>

application/x-www-form-urlencoded
Sample:

Sample not available.

Returns their Reseller API Credentials

CustomerManagementCredentials
Name Description Type Additional information
IsBrightLogic

boolean

None.
ApiKey

string

Required
SitePrefix

string

Required

application/json, text/json
Sample: 
{
  "isBrightLogic": true,
  "apiKey": "sample string 2",
  "sitePrefix": "sample string 3"
}

application/xml, text/xml
Sample: 
<CustomerManagementCredentials xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ApiKey>sample string 2</ApiKey>
  <SitePrefix>sample string 3</SitePrefix>
  <IsBrightLogic>true</IsBrightLogic>
</CustomerManagementCredentials>