If you have your own system and would like to get your enabled activated advertisers or a specific advertiser data without our dashboard, we have just created an API allowing you to do just that. This API is for server to server communication, in case you have your own CRM system or something similar to manage your customer base.
- Url: https://mcpn.us/limeApi?ev=getAdvertisersList
- You must supply one of the following parameters: advertiserId / advertiserUserName / all
- Parameters (case sensitive, bold are mandatory):
|
Parameter Name (Case Sensitive)
|
Value |
Description |
Default Value |
|
user |
Admin username |
The admin’s username that matches the api_id |
None |
|
api_id |
Admin Api Id |
The admin’s api_id that matches the username |
Generated from edit profile |
|
advertiserId |
Number |
Advertiser Id |
The advertiser id for lookup |
|
advertiserUserName |
String |
Advertiser Username |
The advertiser username for lookup |
|
all |
true |
To get a list of all your active advertisers |
|
- Return Code
- If the API succeeds then it will return with status code 200 with xml
- If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.
- If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.
Example:
http://mcpn.us/limeApi?ev=getAdvertisersList&user=admadmin&api_id=a5SNH43WyAA83SWLK&advertiserId=5322
or
http://mcpn.us/limeApi?ev=getAdvertisersList&user=admadmin&api_id=a5SNH43WyAA83SWLK&advertiserUserName=comp1@gmail.com
XML:
- If it's one advertiser lookup that is answer to the parameters: advertiserId or advertiserUserName than the XML will be with one advertiser:
<?xml version="1.0" encoding="UTF-8"?>
<User>
<Id>5322</Id>
<Username>comp1@gmail.com</Username>
<Role>Advertiser</Role>
<DateCreated>12/31/2014 03:00:01 PM</DateCreated>
<FirstName>Jhon</FirstName>
<LastName>Doe</LastName>
<JobTitle>Manager</JobTitle>
<Mobile>15555555555</Mobile>
<Department></Department>
<EmployeeNumber></EmployeeNumber>
<Notes></Notes>
<TimeZone>MST</TimeZone>
<APIID>q4HIADCyLV83822C</APIID>
<CompanyName>My Company</CompanyName>
<Address>16 Main St. </Address>
<City>Ney York</City>
<State>NY</State>
<Country>United States of America</Country>
<ZipCode>11211</ZipCode>
<WebSite></WebSite>
<Phone>15555555554</Phone>
<TollFree></TollFree>
<Fax></Fax>
<Email>comp1@gmail.com </Email>
<CcEmail> </CcEmail>
<BillingEmail></BillingEmail>
<Group></Group>
<SalesAgent></SalesAgent>
<Reseller></Reseller>
</User>
Example:
http://mcpn.us/limeApi?ev=getAdvertisersList&user=admadmin&api_id=a5SNH43WyAA83SWLK&all=true
<?xml version="1.0" encoding="UTF-8" ?>
<Users>
<User>
<Id>5322</Id>
<Username>comp1@gmail.com</Username>
<Role>Advertiser</Role>
<DateCreated>12/31/2014 03:00:01 PM</DateCreated>
<FirstName>Jhon</FirstName>
<LastName>Doe</LastName>
<JobTitle>Manager</JobTitle>
<Mobile>15555555555</Mobile>
<Department></Department>
<EmployeeNumber></EmployeeNumber>
<Notes></Notes>
<TimeZone>MST</TimeZone>
<APIID>q4HIADCyLV83822C</APIID>
<CompanyName>My Company</CompanyName>
<Address>16 Main St. </Address>
<City>Ney York</City>
<State>NY</State>
<Country>United States of America</Country>
<ZipCode>11211</ZipCode>
<WebSite></WebSite>
<Phone>15555555554</Phone>
<TollFree></TollFree>
<Fax></Fax>
<Email>comp1@gmail.com </Email>
<CcEmail> </CcEmail>
<BillingEmail></BillingEmail>
<Group></Group>
<SalesAgent></SalesAgent>
<Reseller></Reseller>
</User>
<User>
<Id>5345</Id>
<Username>comp2@gmail.com</Username>
<Role>Advertiser</Role>
<DateCreated>04/16/2015 07:43:23 PM</DateCreated>
<FirstName>Jane</FirstName>
<LastName>Doe</LastName>
<JobTitle> </JobTitle>
<Mobile>15555555553</Mobile>
<Department></Department>
<EmployeeNumber></EmployeeNumber>
<Notes></Notes>
<TimeZone>MST</TimeZone>
<APIID>aDTDSQK6dGB1s3R</APIID>
<CompanyName>Company</CompanyName>
<Address>52 Main Rd. </Address>
<City>Ney Jersey</City>
<State>NJ</State>
<Country>United States of America</Country>
<ZipCode>21211</ZipCode>
<WebSite></WebSite>
<Phone>15555555552</Phone>
<TollFree></TollFree>
<Fax></Fax>
<Email>comp2@gmail.com </Email>
<CcEmail> </CcEmail>
<BillingEmail></BillingEmail>
<Group></Group>
<SalesAgent></SalesAgent>
<Reseller></Reseller>
</User>
</Users>
Comments
0 comments
Please sign in to leave a comment.