Help Center Manage Your Account AdSpeed API
AdSpeed API Overview
AdSpeed API (Application Programming Interface) is a value-added service we provide to all clients. Publishers and advertisers can write software to automatically collect information about their zones, ads, campaigns, and reports directly from AdSpeed. Web developers are also encouraged to use the API to build applications on our platform. We reserve the right to change the API details and decline or terminate access prior or without notice.API Key and API Secret
You need an API key and an API secret to use the API. They can be viewed under the menu Tools / API for Developers. The API key is required on all requests from your application to our system. The API secret is used to sign each request.Making Request
Requests are made by issuing simple REST queries to our API server. Limit 600 requests per hour (across all methods) and 2400 requests per 24-hour period (for each individual method). Certain methods might have additional restrictions and specifications. If you need a higher limit, please contact us for a custom quote.Sample GET Request
https://api.adspeed.com/?key=YOUR_API_KEY&method=METHOD_NAME¶m1=VALUE¶m2=VALUE&sig=REQUEST_SIGNATURE
Sample POST Request
EndPoint_URL = 'https://api.adspeed.com/'; POST_Data = array( 'key' = YOUR_API_KEY, 'method' = METHOD_NAME, 'param1' = VALUE, 'param2' = VALUE, 'sig' = REQUEST_SIGNATURE );
Response
Results are sent back in XML format, which could be read by any standard XML parser. Example:<Response version="1.0.0 (build 123456)"> <Zones active="8" deleted="2" total="10"></Zones> </Response>
Signing Request
ReplaceYOUR_KEY
and YOUR_SECRET
with the actual value provided in your account. Each API call must be signed with the following steps:
- Sort all parameters in alphabetical order. Encode each value if it contains special characters. Join parameters with "&" into a string.
Example: a=value&key=YOUR_KEY&method=CallName&x=value&y=value
- Prepend your secret string to the beginning of the sorted argument string in Step 1
Example: YOUR_SECRETa=value&key=YOUR_KEY&method=CallName&x=value&y=value
- Generate a lower-case hash (MD5) for the string in Step 2
Example: e370e20446c98b1f0ac5d0de43c2707c
- Append the hash to the call as an additional parameter
Example: a=value&key=YOUR_KEY&method=CallName&x=value&y=value&sig=e370e20446c98b1f0ac5d0de43c2707c
Code Sample
We have prepared an example PHP class to access our API.API Version
1.4.6 (build 20240530). This page was updated on Sat, 09 Nov 24 17:27:45 -0500. Since the API method and response format can change from one version to another, you should check this page for updates.API Methods - Overview
- AS.Publisher.getStats
- AS.Publisher.getBreakdownStats
- AS.Publisher.getVisitorStats
- AS.Zones.getCounts
- AS.Zones.getList
- AS.Zones.create
- AS.Zone.getInfo
- AS.Zone.getRates
- AS.Zone.edit
- AS.Zone.setRate
- AS.Zone.addRestriction
- AS.Zone.getAdTag
- AS.Zone.getStats
- AS.Zone.getBreakdownStats
- AS.Zone.getVisitorStats
- AS.Groups.getCounts
- AS.Groups.getList
- AS.Groups.create
- AS.Group.getInfo
- AS.Group.getStats
- AS.Group.getBreakdownStats
- AS.Group.getVisitorStats
- AS.Group.edit
- AS.Channels.getCounts
- AS.Channels.getList
- AS.Medias.upload
- AS.Websites.getCounts
- AS.Websites.getList
- AS.Website.getInfo
- AS.Website.getStats
- AS.Advertisers.getCounts
- AS.Advertisers.getList
- AS.Advertisers.create
- AS.Advertisers.checkUsernamePassword
- AS.Advertiser.getInfo
- AS.Advertiser.changePassword
- AS.Advertiser.editContact
- AS.Ads.getCounts
- AS.Ads.getList
- AS.Ads.createBanner
- AS.Ads.createVideo
- AS.Ads.createVASTWrapper
- AS.Ads.createHTML
- AS.Ads.createText
- AS.Ad.linkToZone
- AS.Ad.unlinkFromZone
- AS.Ad.linkToGroup
- AS.Ad.unlinkFromGroup
- AS.Ad.linkToAdvertiser
- AS.Ad.placeOrder
- AS.Ad.edit
- AS.Ad.getRestrictions
- AS.Ad.addRestriction
- AS.Ad.getAdTag
- AS.Ad.getLinkedZones
- AS.Ad.getAdTagForLinkedZones
- AS.Ad.getStats
- AS.Ad.getVisitorStats
- AS.Campaigns.getCounts
- AS.Campaigns.getList
Other Articles in AdSpeed API
Documentation to use AdSpeed API to integrate AdSpeed AdServer into your own platform.
Cannot find an answer for your question? Ask our Customer Care team
Related
- Campaign
"Documentation for API methods to manage your campaigns in our ad server. API Version1.4.6 (build 20240530). This page was updated ..."
- Website
"Documentation for API methods to manage one or multiple websites. API Version1.4.6 (build 20240530). This page was updated on Mon, ..."
- Channel
"A channel is a collection of zones. For publishers or ad networks with many zones, it is better to group ..."
- How can I serve multiple zones with a single server request?
"This method is highly recommended if you have 3 or more ad placements on a page. It combines all ad ..."
- Smart Group and Smart Zone
"A smart zone or group automatically links to ads with certain attributes. For example, you want to create a group/zone ..."