/servlet/control/api/advertisers/authenticate
Allows you to authenticate an advertiser given a username and password, which is useful for implementing single sign-on with external systems that you might develop or integrate with the API.
/servlet/control/api/advertisers/authenticate
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) |
|---|---|---|---|---|
| secret | String | Yes | a78bf24c5a23581aceba1c5f51ac4cad | Must be a String containing no more than 32 characters |
| output | String | No | xml | Must be a String equal to either json or xml |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) |
| username | String | Yes | admin | Must be the username of an existing advertiser (case sensitive) |
| password | String | Yes | password | Must be the password of an existing advertiser (case sensitive) |
/servlet/control/api/advertisers/authenticate?secret=(key)&username=acme&password=coyote
<advertiser id="123" name="ACME" username="acme" status="true" recycle="false">
<notes/>
<information company="ACME Company" name="John Doe" title="" email="john@acme.com" website="http://www.acme.com/" phone="123-456-7890" mobile="123-456-7890" fax="123-456-7890">
<address><![CDATA[123 Acme Street
New York, NY 10001]]></address>
<notes/>
</information>
<contacts>
<contact name="Jane Doe" title="" email="jane@acme.com" phone="123-456-7890" />
</contacts>
<config>
<setting name="HOME_DATE_RANGE" value="thirty"/>
<setting name="HOME_MEDIA_FILTER" value=""/>
<setting name="HOME_COMPARE_BY" value="clickratio"/>
<setting name="HOME_ITEM_COUNT" value="25"/>
<setting name="RECENT_EMAIL_FREQUENCY" value="never"/>
<setting name="RECENT_EMAIL_FORMAT" value="HTML"/>
<setting name="REPORTS_HIDE_GRAPHS" value="false"/>
<setting name="REPORTS_HIDE_EMPTY" value="false"/>
<setting name="REPORTS_INCLUDE_DEFINITIONS" value="true"/>
</config>
<permissions>
<action>LOGIN</action>
<action>ACCOUNTS</action>
<action>ACCOUNTS_VIEW</action>
<action>ACCOUNTS_EDIT</action>
<action>MEDIA</action>
<action>MEDIA_LISTING</action>
<action>MEDIA_SEARCH</action>
<action>MEDIA_PREVIEW</action>
<action>MEDIA_VIEW</action>
<action>MEDIA_STATUS</action>
<action>FILES</action>
<action>CAMPAIGNS</action>
<action>CAMPAIGNS_LISTING</action>
<action>CAMPAIGNS_SEARCH</action>
<action>CAMPAIGNS_VIEW</action>
<action>CAMPAIGNS_STATUS</action>
<action>REPORTS</action>
<action>REPORTS_ACCOUNTING</action>
<action>REPORTS_GENERAL</action>
<action>REPORTS_CAMPAIGNS</action>
<action>REPORTS_GROUPS</action>
<action>REPORTS_MEDIA</action>
<action>REPORTS_PUBLISHERS</action>
<action>REPORTS_ZONES</action>
<action>REPORTS_CONVERSIONS</action>
<action>REPORTS_CUSTOM</action>
<action>REPORTS_DAILY</action>
<action>REPORTS_ENGAGEMENT</action>
<action>REPORTS_EVENTS</action>
<action>REPORTS_GEOGRAPHY</action>
<action>REPORTS_HOURLY</action>
<action>REPORTS_INTERACTIVE</action>
<action>REPORTS_KEYWORDS</action>
<action>REPORTS_LANGUAGES</action>
<action>REPORTS_NETWORK</action>
<action>REPORTS_REFERRER</action>
<action>REPORTS_ROI</action>
<action>REPORTS_SOFTWARE</action>
<action>REPORTS_VIDEO</action>
<action>REPORTS_VIEWABILITY</action>
<action>REPORTS_WEATHER</action>
<action>TOOLS</action>
</permissions>
<competitors>
<id>2</id>
<id>3</id>
<id>4</id>
<id>20</id>
</competitors>
<optout>
<id>7</id>
<id>8</id>
<id>9</id>
</optout>
<pixels action="123" retargeting="123"/>
<regulations>
<countries unknown="false">
<country id="ca"/>
<country id="us"/>
</countries>
<keywords/>
</regulations>
<roadblocks>
<campaigns>
<id>1000</id>
<id>1001</id>
</campaigns>
<zones>
<id>10</id>
<id>22</id>
<id>31</id>
</zones>
</roadblocks>
</advertiser>
/servlet/control/api/advertisers/authenticate?secret=(key)&output=json&username=acme&password=coyote
{
"id": 123,
"name": "ACME",
"username": "acme",
"status": true,
"recycle": false,
"notes": "",
"information": {
"company": "ACME Company",
"name": "John Doe",
"title": "",
"email": "john@acme.com",
"website": "http://www.acme.com/",
"phone": "123-456-7890",
"mobile": "123-456-7890",
"fax": "123-456-7890",
"address": "123 Acme Street\r\nNew York, NY 10001",
"notes": ""
},
"contacts": [
{
"name": "Jane Doe",
"title": "",
"email": "jane@acme.com",
"phone": "123-456-7890"
}
],
"config": {
"HOME_DATE_RANGE": "thirty",
"HOME_MEDIA_FILTER": "",
"HOME_COMPARE_BY": "clickratio",
"HOME_ITEM_COUNT": 25,
"RECENT_EMAIL_FREQUENCY": "never",
"RECENT_EMAIL_FORMAT": "HTML",
"REPORTS_HIDE_GRAPHS": false,
"REPORTS_HIDE_EMPTY": false
"REPORTS_INCLUDE_DEFINITIONS": true
},
"permissions": [
"LOGIN",
"ACCOUNTS",
"ACCOUNTS_VIEW",
"ACCOUNTS_EDIT",
"MEDIA",
"MEDIA_LISTING",
"MEDIA_SEARCH",
"MEDIA_PREVIEW",
"MEDIA_VIEW",
"MEDIA_STATUS",
"FILES",
"CAMPAIGNS",
"CAMPAIGNS_LISTING",
"CAMPAIGNS_SEARCH",
"CAMPAIGNS_VIEW",
"CAMPAIGNS_STATUS",
"REPORTS",
"REPORTS_ACCOUNTING",
"REPORTS_GENERAL",
"REPORTS_CAMPAIGNS",
"REPORTS_CONVERSIONS",
"REPORTS_CUSTOM",
"REPORTS_GROUPS",
"REPORTS_MEDIA",
"REPORTS_PUBLISHERS",
"REPORTS_ZONES",
"REPORTS_DAILY",
"REPORTS_ENGAGEMENT",
"REPORTS_EVENTS",
"REPORTS_GEOGRAPHY",
"REPORTS_HOURLY",
"REPORTS_INTERACTIVE",
"REPORTS_KEYWORDS",
"REPORTS_LANGUAGES",
"REPORTS_NETWORK",
"REPORTS_REFERRER",
"REPORTS_ROI",
"REPORTS_SOFTWARE",
"REPORTS_VIDEO",
"REPORTS_VIEWABILITY",
"REPORTS_WEATHER",
"TOOLS"
],
"competitors": [
2,
3,
4,
20
],
"optout": [
7,
8,
9
],
"pixels" : {
"action": 123,
"retargeting": 123
},
"regulations": {
"countries": [
"ca",
"us"
],
"keywords": []
},
"roadblocks": {
"campaigns": [
1000,
1001
],
"zones": [
10,
22,
31
]
}
}