AUTH Login API Version 2

Updated on 2014-06-03
Current Version: Version 2
Deprecated Version: NA
Requests Allowed: GET&SOAP


Summary:

Returns the "Success" true. Also returns "success_info" object with details about the authenticated user.


Resource/WSDL Page:

https://<your_domain_here>/api/2/auth.asmx?op=Login


Parameters

username
Required
Type: STRING

 

 

password
Required
Type: STRING

 

 

ip_address
Type: STRING

System will lookup the IP address whether or not it is passed by the user. Also, if the IP Address matches that of different recently authenticated Affiliate, two alerts will be triggered:

1) Affiliate Login Outside Signup Radius
2) Affiliate Login Duplicate IP

 **Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 

 

Example Request

GET

https://demo.cakemarketing.com/api/2/auth.asmx/Login?username=andy@getCAKE.com&password=a069gsSDG934&ip_address=8.8.8.8

 

Sample XML Response:

<login_response>
  <success>true</success>
  <row_count>1</row_count>
  <login_info>
    <contact_id>3219</contact_id>
    <contact_first_name>Andy</contact_first_name>
    <contact_last_name>Worford</contact_last_name>
    <role_id>6</role_id>
    <role_name>Affiliate</role_name>
    <company_id>5931</company_id>
    <company_name>CPA API</company_name>
    <api_key>xHeSkLoXt70</api_key>
    <server_time>2012-09-18T10:40:07.1110505-07:00</server_time>
    <server_timezone>Pacific Daylight Time</server_timezone>
  </login_info>
</login_response>


Example Error Messages:  

Error Message

Likely Cause

Invalid username and/or password

Unable to locate user based on provided username/password combination.