Publisher API

From Wiki

Jump to: navigation, search

Contents

Introduction

The Publisher API offers a set of API calls that allow you to pull data about the programs on the platform, the commission you can earn from those programs, your transactions and aggregated reports.

The API uses REST as a standard, with oauth2 for authentication, and JSON as the default response data format.

How to access the API

The API is available via https://api.awin.com. Please note that only https is supported, no forwarding from http is in place.
Before you can use it you need to create your own oauth2 token via https://ui.awin.com/awin-api
Please see the wiki page API authentication and authorization for further details.

Limitation/Throttling

To guarantee smooth operation for all our publishers and advertisers, we currently have a throttling in place that limits the number of API requests to 20 API calls per minute per user.

API requests

Request

Description

GET accounts

provides a list of accounts you have access to

GET programmes

provides a list of programmes available on the platform

GET programmedetails

provides detailed information about a programme you have an active relationship with

GET commissiongroups

provides information about the commissions you get from a certain programme

GET commissionsharingrules

enables service partners to pull their commission sharing rules

GET transactions (list)

provides a list of your individual transactions

GET transactions (by ID)

provides individual transactions by ID

GET reports aggregated by advertiser

provides aggregated reports for the advertisers you work with

GET reports aggregated by creative

provides aggregated reports for the creatives you used

GET transaction query data

provides a list of transaction query data

GET reports aggregated by campaign

provides aggregated reports for the campaigns you promote for the advertisers you work with

POST generate tracking link

generates Awin tracking links based on the destination URL and advertiser you provide

POST Offers

allows publishers to retrieve details of promotions and voucher codes offered by advertisers
Feedback on our API? Please take a few minutes to fill out our Product Feedback form.

Privacy

Due to new European legislation regarding how websites store information about you, AWIN is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button