API Documentation

From API :: Performance Horizon Group Ltd
(Redirected from Main Page)
Jump to: navigation, search

The Performance Horizon API has been designed for use in various scenarios, ranging from publishers remotely downloading conversion reports, to advertisers and agencies building their own white label performance marketing network.

We have designed the API to be as flexible as possible, implemented in both XML and JSON over HTTP, using as many of the REST principles as possible. That big collection of abbreviations should hopefully result in lots of fun working with our API, and ensure that any previous API work you have done with other frameworks should be simple to port across to fit in with ours.

Access and Authentication

To use the API, you must have a valid API Key and a user account with PHG. You can obtain a key by contacting the friendly chaps at support@performancehorizon.com [1] We also have a demo API, which you can use to play around with the various methods, and create as much test data as you like. This allows you to become familiar with the framework before launching a live application through it.

Every API call uses HTTP BASIC authentication over HTTPS, and conforms to the same standard format:

https://api_key:user_api_key@api.performancehorizon.com/api_method/

The api_key is the application key, this is directly related to the application you are accessing through the API. This may be an existing application, or you may be the proud owner of your very own. The user_api_key is the unique API key for the user to which the API request relates.

You can specify the response format from the API, JSON is the default but XML is also available. To specify the format, simply complete the API URI with .json or .xml respectively.

All key value pairs are separated with a forward slash, an example of a method call for campaign, passing a campaign id of 5 would be:

GET https://api_key:user_api_key@api.performancehorizon.com/campaign/5.xml

Note, in the above example, the API return format of XML was specified.

API Methods

The following list covers all the public facing API methods. They range from user administration, to account specific reporting, through to full campaign management.

User Methods

The user methods allow you to create a user and ultimately assign an advertiser or publisher account to that user.

Advertiser Methods

In order to have an active campaign running on the network, it must be part of an advertiser account.

Campaign Methods

The campaign methods allow an advertiser to administer their own campaign(s).

Commission Methods

Commission points can be set at multiple levels of the campaign, to allow a high level of granularity when defining the incentives.

Commission Group Methods

In order to manage commission points more efficiently, it is possible to organise publishers into commission groups. This allows you to set a commission point on a group of publishers.

Voucher Code Methods

Publisher Participation Methods

All Publishers who wish to generate conversions for a campaign must be approved to do so.

Creative Methods

A campaign can offer its publishers a range of creative to be used in promotional methods.

Reporting Methods (Advertiser)

The reporting methods return all of the campaign related data generated by publishers.

Invoice Methods

The invoice methods allow an advertiser to retrieve and view all raised invoices.

Conversion Methods

All conversions must be either approved or rejected. The status can be updated on a conversion, or conversion item level.

Dispute Methods (Advertiser)

A publisher may raise transaction disputes from time to time. These methods allow you to manage and resolve these.

Tracking Methods

In order to track conversions on a campaign, the details of each conversion must be passed to the PHG tracking server.

Leadgen Blacklist Methods

Captured lead data can be checked against blacklists, both pre-defined and custom.

Feed Methods (Advertiser)

PHG offers a powerful feeds service.

Publisher Methods

A publisher account is used to generate conversions for an advertiser campaign. A publisher must have at least 1 website or 1 database entry to accompany their standard account information.

Reporting Methods (Publisher)

The reporting methods return all of the campaign related data generated by a publisher.

Self-Bill Methods

The self-bill methods allow a publisher to retrieve and view bills that have been generated.

Dispute Methods (Publisher)

Allows a publisher to lodge a dispute against a transaction.

Website Methods

Details about the publisher's website(s).

Database Methods

Details about the publisher's database(s).

Campaign Methods (Publisher)

Publishers must be associated with a campaign in order to record conversions. These functions allow a publisher to request access to a campaign

Reference Methods

Reference methods are used to grab restricted field values, these are used to ensure valid data is passed for various method calls.

Network Methods

Network methods apply to the entire network, and affect all types of users.

News Methods

Network news allows communication to be sent to all users within the network.

Email Methods

Emails are specific communications sent to publishers based on their participation on campaigns, campaign groups or networks

Communication Filter Methods

Emails and news can have filters applied to them so they only appear/get sent to a specific set of contacts

Help Methods

Help/FAQ to assist users of the network with common questions and answers.