Web Services

What's New

Shutoff of Data API 2009 and 2010
On the 8th of April, we switched the default Data API endpoint and the default wsdl - http://data.zanox.com/soap and http://data.zanox.com/wsdl respectivelty - over to the 2011 version.

On April 15, the 2009 and 2010 versions of Data API were taken offline. If you haven't done so, make sure you migrate your client to the 2011 version.

Useful links:
Documentation Data API 2009
Documentation Data API 2011. This article also contains an overview of differences between the 2009, 2010 and 2011 API versions.

Removal of indirect partnership functionality
Since Friday, November 23, 2012, you are no longer be able to use the Publisher API to access ad media, products, or incentives from indirect partnerships, i.e. from advertisers to which you are not directly applied. This affects the following methods: GetAdMedia, GetAdMedium, GetIncentive, GetProduct, SearchIncentives, and SearchProducts.

Please be sure to update your scripts and applications to rely only on direct partnerships.

Shutoff of 2009 API
On November 3, 2012, the Publisher API v2009-07-01 was shut off in accordance with the Web Services migration strategy.

For detailed instructions about how to migrate to the most recent Publisher API version (v2011-03-01), please follow Changeover 2009 to 2011. If you have any questions, please post them to the mailing list.

Getting Started

zanox Web Services consist of a Publisher API which covers most of the publisher-side functionality of the zanox platform. The API can be used to manipulate the data in your own zanox publisher account, or to create applications which manipulate the data on behalf of other publishers.

Before getting started, read these first:

• User Authentication / API Credentials
• Paging
• Date formats
• API Explorer
• Code examples using the PHP Client Library
• Support and developer mailing list

Then get your API credentials by signing in with your zanox publisher account.

We strongly recommend using a Client Library to interact with the Publisher API. zanox officially offers two Client Libraries, and will support developers attempting to use these:

• PHP Client Library
• Java Client Library

In addition, zanox employees maintain the following Client Libraries in their spare time. As such, these are used at your own risk:

• .NET C# Client Library
• Ruby Client Library
• Erlang Client Library

Note that zanox will not support developers attempting to calculate their own security credentials, without using a Client Library.

Request Formats:

• REST
• SOAP

Response Formats:

• XML
• JSON
• JSONP
• SOAP

If you are interested in developing tools to be used by other publishers, please contact our third party cooperations guru Ralf Belusa.

Ad Media - get banners and links, including tracking links.

• GetAdmedia
• GetAdmedium
• GetAdmediumCategories

Adspaces

• CreateAdspace
• DeleteAdspace
• GetAdspace
• GetAdspaces
• UpdateAdspace

Aggregated Reports - get an overview of sales and leads activities, e.g. grouped by day.

• GetReportBasic

Balance

• GetBalance
• GetBalances

BankAccount

• GetBankAccount
• GetBankAccounts

Incentives - get coupons and other incentives

• GetExclusiveIncentive
• GetIncentive
• SearchExclusiveIncentives
• SearchIncentives

Leads and Sales - get individual sales and leads.

• GetLead
• GetLeads
• GetSale
• GetSales

Payment

• GetPayment
• GetPayments

Products - get zanox product data, including tracking links.

• GetProduct
• GetProductCategories
• SearchProducts

Profile

• GetProfile
• UpdateProfile

Program - get information regarding zanox advertisers.

• GetProgram
• GetProgramCategories
• SearchPrograms

ProgramApplication - apply to advertiser programs, get information about applications, end partnerships.

• CreateProgramApplication
• GetProgramApplications
• DeleteProgramApplication

Tracking Categories - get advertiser commission models.

• GetTrackingCategories