PUBLISHER

ADVERTEERDER

AGENTSCHAPPEN

PARTNER PROGRAMMAS

Programma Aanbod

APPS & API'S

PERS

OVER ONS

API-Documentation- Publisher Partnerprograms Web Services V1.1

1 Content

1	Content
2	Introduction
3	Generating A Web Service-Password
4	Publisher Partner Programs Web Services
4.1	Result-Object
4.2	Functions
4.2.1	getPrograms()
4.2.2	getProgramDetails()
4.2.3	getProgramConditionDetails()
4.2.4	searchPrograms()
4.2.5	getNewPrograms()
4.2.6	getProgramCategories()
4.2.7	getProgramsByCategory()
4.2.8	searchCommonAds()
5	Change-log

2 Introduction

The belboon Web Services (SOAP-Protokoll) enables you to work with our network automatically without you having to login through the interface.

WebService-URL: http://api.belboon.com/?wsdl

3 Generating A Web Service-Password

To use the belboon-web services you do not need to login to your belboon account.

In the Menu "Tools & Services > Webservices" you have the opportunity to generate your web service password. Afterwards you will be able to see this in this section. The username for the use of the web services is exactly the same as the username from your Affiliate account.

4 Publisher Partner Programs Web Services

4.1 Result Object

When calling a function of the Web Services, the data will be returned through a single result object. This object contains some metadata, for example: an error message as well as the actual user data.

Result Object

Property	Type	Description
processor	Object	s.u.
handler	Object	s.u.

processor

Behind the property lies a processor object, which stores information about the executed transaction.

Property	Type	Description
code	Integer	Transactions code
message	String	Message according to the transaction codes
rid	Integer	SOAP-Requests ID
testmode	Integer	Provides information on whether the transaction was carried out in test mode.

handler

The property handler contains a single property whose name, type and content results on the call up of the web services. This information must in any case be checked again in Section 4.2. The contents of this property are the actual user data.

4.2 Functions

4.2.1 getPrograms()

Request-Parameter

Name	Type	Default	Description
adPlatformId	Integer		Limits the selection of partner programs, to those programs with a partnership for the selected platform
programLanguage	String {DE, EN, FR, NL, ...}	null
partnershipStatus	String {AVAILABLE, PENDING, PARTNERSHIP, PAUSED, REJECTED}	null	Status of the partnership
query	String	null	Only partner programs will be returned, that are named in the query string
orderBy	String[] (Array)	array('programid' => 'ASC')	Organizes the return of the partner programs through the columns, sorted per requirement. (ASC = ascending, DESC= descending)
limit	Integer	null	Limits the number of results to max. sum.
offset	Integer	0	Limits the number of results from this sum.

Response (handler)

Behind the property handler lies the Result-object, an object, with a single publicly visible property that bears the name of the partner programs. It contains a numerically indexed array of 0 or more rows (arrays), each of which is structured as follows:

Index	Type	Description
programid	Integer	Partner Program ID
programname	String	Name of the Partner Programs
programlanguage	String	Program Language
programdescription	String	Program Description
programterms	String	Program Terms
advertiserurl	String	Merchant URL
programlogo	String	Partner Program Logo URL
programregisterurl	String	Partner Program Registration Page URL
partnershipstatus	String {AVAILABLE, PENDING, PARTNERSHIP, PAUSED, REJECTED}	Partnership Status
partnershipid	Integer	Partnership ID - when partnership is active
programcurrency	String {EUR, GBP, USD, ...}
commissionviewmin	Float	Minimum View commission in Program currency
commissionviewmax	Float	Maximum View commission in Program Currency
commissionclickmin	Float	Minimum Click commission in Program Currency
commissionclickmax	Float	Maximum click commission in Program Currency
commissionleadmin	Float	Minimum Lead commission in Program Currency
commissionleadmax	Float	Maximum Lead commission in Program Currency
commissionsaleminfix	Float	Minimum fixed Sale commission in Program Currency
commissionsalemaxfix	Float	Maximum fixed Sale commission in Program Currency
commissionsaleminpercent	Float	Minimum Percent Sale commission in Program Currency
commissionsalemaxpercent	Float	Maximum Percent Sale commission in Program Currency

Example:

<?php define('WSDL_SERVER', 'http://api.belboon.com/?wsdl'); // SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true ); try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getPrograms( <YOUR_AD_PLATFORM_ID>, // adPlatformId 'DE', // programLanguage null, // partnershipStatus utf8_encode('gewinn'), // query array('commissionsalemaxfix' => 'DESC'), // orderBy 10, // limit 0 // offset ); echo '<pre>'; print_r($result); } catch( Exception $e ) { // Error handling here... }

4.2.2 getProgramDetails()

Request Parameter

Name	Type	Default	Description
programId	Integer

Response (handler)

Hidden Behind the property handler of the Result object is an object with the following publicly visible properties:

Index	Type	Description
cookieLifetime	Integer	X Days
trackingTechniques	String[] (Array) {FINGERPRINT, COOKIE, SESSION, FLASH}	Tracking methods for the Partner Program
inCategories	Integer[]	Program Category IDs
startDate	DateTime (YYYY-MM-DD hh:mm:ss)	Start date of the Partner program
endDate	DateTime (YYYY-MM-DD hh:mm:ss)	End date of the Partner program
hasVoucherCodes	Boolean	TRUE=Voucher Code -available
hasProductFeeds	Boolean	TRUE=Datafeed available
hasMobileAds	Boolean	TRUE=Mobile Advertising Material available
hasAutoAccept	Boolean	AutoAccept Merchant
hasAutoAcceptPremium	Boolean	AutoAccept for Premium Partners
tradingAreas	String[] (Array)	List of the Programs listed trading areas (Country codes)
ephcAverage	Float	90 Day average EPHC in programs currency
ephcBest	Float	90 Day EPHC of the programs best Publisher in Program currency
rejectionRate	Float	Cancellation rate in Percent
averageProcessingTimeLeads	Integer	Average time it takes the merchant to edit leads in Days
averageProcessingTimeSales	Integer	Average time it takes the merchant to edit Sales in Days
forcedClicksAllowed	Boolean	TRUE=ForcedClicks allowed
allowedAdPlatformTypes	String[] (Array) {WEBSITE, NEWSLETTER, MOBILE, SOFTWARE, SEM_SEO}	Types of accepted adplatforms

Example:

<?php define('WSDL_SERVER', 'http://api.belboon.com/?wsdl'); // SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true ); try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getProgramDetails(<ANY_PROGRAM_ID>); echo '<pre>'; print_r($result); } catch( Exception $e ) { // Error handling here... }

4.2.3 getProgramConditionDetails ()

Request-Parameter

Name	Type	Default	Description
programId	Integer		Partner Program ID
adPlatformId	Integer	null	AdPlatform ID

Response (handler)

Behind the property handler of the Result-Object lies again an object that has the following public poperties::

Index	Type	Description
programId	Integer	Partner Program ID
programName	String	Name of Partner Program
conditionGroupName	String	Name of Condition Group
conditions	Array

Behind the property conditions lies a numeric indexed array („conditions") with one or more rows (arrays), structured as following:

Index	Type	Description
conditionname	String	Name of Condition
conditiontype	String {BASIC, SPECIAL}	Condition Type
conditionstart	DateTime (YYYY-MM-DD hh:mm)	Condition Start Date
conditionend	String	Condition End Date
productgroups	Array

Behind the Index productgroups lies a numeric indexed array („productgroups") with one or more rows (arrays), structured as following:

Index	Type	Description
productgroupname	String	Name of Product Group
productgroupeventtype	String {CLICK, VIEW, LEAD, SALE}	Event-Type of Product Group
productgroupprovisionfix	Float	Fix Commission of this Product Group
productgroupprovisionpercent	Float	Percentage Commission of this Product Group (SALE only)
scales	Array

Behind the Index scales lies a numeric indexed array („scales") with 0 or more rows, structured as following:

Index	Typ	Description
scalevalue	Integer / Float	Threshold of Scale
scaleisturnover	Boolean	Threshold of commissions (Float), else number of Events (Integer)
scaleprovisionfix	Float	Fix commission at reaching the scale-threshold
scalesprovisionpercent	Float	Percentage commission at reaching the scale-threshold

Example:

<?php define('WSDL_SERVER', 'http://api.belboon.com/?wsdl'); // SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true ); try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getProgramConditionDetails( <ANY_PROGRAM_ID>, // programId <YOUR_AD_PLATFORM_ID> // adPlatformId ); echo '<pre>'; print_r($result); } catch( Exception $e ) { // Error handling here... }

4.2.4 searchPrograms()

Request-Parameter

Name	Type	Default	Description
adPlatformId	Integer		Limits the selection of programs to the platform where there is an active partnership
programLanguage	String {DE, EN, FR, NL, ...}	null	Only partner programs are returned, that are set in the programs main language
partnershipStatus	String {AVAILABLE, PENDING, PARTNERSHIP, PAUSED, REJECTED}	null
query	String	null	Only partner programs will be returned, that are named in the query string
hasProductFeeds	Boolean	null	TRUE= Only partner programs are returned, that offer an active Datafeed
hasVoucherCodes	Boolean	null	TRUE= Only partner programs are returned, that offer active Voucher Codes
hasMobileAds	Boolean	null	TRUE= Only partner programs are returned, that offer an active Mobile advertising material
programStartSince	Date	null	Returns all Programs, that have started since (incl.) the stated date
categoryId	Integer	null	Only partner programs will be returned, that are specified in the program catalogue.
includeSubCategories	Boolean	null	TRUE=Provided categoryId is queried, all Sub Category Partner Programs from categoryId will also be included.
orderBy	String[] (Array)	array( 'programname' => 'ASC ')	Organizes the return of the partner programs through the columns, sorted per requirement. (ASC = ascending, DESC= descending)
limit	Integer	null	Limits the number of results to max. sum.
offset	Integer	0	Limits the number of results from this sum.

Response (handler)

Behind the property handler lies the Result-object, an object, with a single publicly visible property that bears the name of the partner programs. It contains a numerically indexed array of 0 or more rows (arrays), each of which is structured as follows:

Index	Type	Description
programid	Integer	Partner Program ID
programname	String	Name of the Partner Programs
programlanguage	String	Program Language
programdescription	String	Program Description
programterms	String	Program Terms
advertiserurl	String	Merchant URL
programlogo	String	Partner Program Logo URL
programregisterurl	String	Partner Program Registration Page URL
partnershipstatus	String {AVAILABLE, PENDING, PARTNERSHIP, PAUSED, REJECTED}	Partnership Status
partnershipid	Integer	Partnership ID - when partnership is active
programcurrency	String {EUR, GBP, USD, ...}
commissionviewmin	Float	Minimum View commission in Program currency
commissionviewmax	Float	Maximum View commission in Program Currency
commissionclickmin	Float	Minimum Click commission in Program Currency
commissionclickmax	Float	Maximum click commission in Program Currency
commissionleadmin	Float	Minimum Lead commission in Program Currency
commissionleadmax	Float	Maximum Lead commission in Program Currency
commissionsaleminfix	Float	Minimum fixed Sale commission in Program Currency
commissionsalemaxfix	Float	Maximum fixed Sale commission in Program Currency
commissionsaleminpercent	Float	Minimum Percent Sale commission in Program Currency
commissionsalemaxpercent	Float	Maximum Percent Sale commission in Program Currency

Example:

<?php define('WSDL_SERVER', 'http://api.belboon.com/?wsdl'); // SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true ); try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->searchPrograms( <YOUR_AD_PLATFORM_ID>, // adPlatformId 'DE', // programLanguage, 'AVAILABLE', // partnershipStatus null, // query true, // hasProductFeeds false, // hasVoucherCodes null, // hasMobileAds date('Y-m-d', time() - 10 * 24 * 60 * 60), // programStartSince null, // categoryId null, // includeSubCategories array('commissionleadmax' => 'DESC'), // orderBy 10, // limit 0 // offset ); echo '<pre>'; print_r($result); } catch( Exception $e ) { // Error handling here... }

4.2.5 getNewPrograms()

Delivers all programs started within the last 30 days

Request-Parameter

Name	Type	Default	Description
adPlatformIds	Integer		Limits the selection of programs to the platform where there is an active partnership
programLanguage	String {DE, EN, FR, NL, ...}	null
partnershipStatus	String {AVAILABLE, PENDING, PARTNERSHIP, REJECTED, PAUSED}	null	Partnership Status
orderBy	String[] (Array)	array( 'programstartdate' => 'DESC' )	Organizes the return of the partner programs through the columns, sorted per requirement. (ASC = ascending, DESC= descending)
limit	Integer	null	Limits the number of results to max. sum.
offset	Integer	0	Limits the number of results from this sum.

Response (handler)

Index	Type	Description
programid	Integer	Partner Program ID
programname	String	Name of the Partner Programs
programlanguage	String	Program Language
programdescription	String	Program Description
programterms	String	Program Terms
advertiserurl	String	Merchant URL
programlogo	String	Partner Program Logo URL
programregisterurl	String	Partner Program Registration Page URL
partnershipstatus	String {AVAILABLE, PENDING, PARTNERSHIP, PAUSED, REJECTED}	Partnership Status
partnershipid	Integer	Partnership ID - when partnership is active
programcurrency	String {EUR, GBP, USD, ...}
commissionviewmin	Float	Minimum View commission in Program currency
commissionviewmax	Float	Maximum View commission in Program Currency
commissionclickmin	Float	Minimum Click commission in Program Currency
commissionclickmax	Float	Maximum click commission in Program Currency
commissionleadmin	Float	Minimum Lead commission in Program Currency
commissionleadmax	Float	Maximum Lead commission in Program Currency
commissionsaleminfix	Float	Minimum fixed Sale commission in Program Currency
commissionsalemaxfix	Float	Maximum fixed Sale commission in Program Currency
commissionsaleminpercent	Float	Minimum Percent Sale commission in Program Currency
commissionsalemaxpercent	Float	Maximum Percent Sale commission in Program Currency

Example:

<?php define('WSDL_SERVER', 'http://api.belboon.com/?wsdl'); // SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true ); try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getNewPrograms( <YOUR_AD_PLATFORM_ID>, // adPlatformId 'DE', // programLanguage 'AVAILABLE', // partnershipStatus array('programname' => 'ASC'), // orderBy 10, // limit 0 // offset ); echo '<pre>'; print_r($result); } catch( Exception $e ) { // Error handling here... }

4.2.6 getProgramCategories()

Request Parameter

Name	Type	Default	Description
language	String		Defines the language in which the return is to be translated
categoryId	Integer	null	Lists Program categories below the specified category
query	String	null	Only partner programs will be returned, that are named in the query string
orderBy	String[] (Array)	array('categoryname' => 'ASC')	Organizes the return of the partner categories through the columns, sorted per requirement. (ASC = ascending, DESC= descending)
limit	Integer	null	Limits the number of results to max. sum.
offset	Integer	0	Limits the number of results from this sum.

Response (handler)

Behind the property handler lies the Result-object, an object, with a single publicly visible property that bears the name of the programCategories. It contains a numerically indexed array of 0 or more rows (arrays), each of which is structured as follows:

Index	Type	Description
categoryid	Integer	Category ID
categoryname	String	Category Name
parentcategoryid	Integer	Parent Category ID
subcategories	Integer[] (Array)	List of the sub catgory IDs
amountofprograms	Integer	Number of the programs in the category

Example:

<?php define('WSDL_SERVER', 'http://api.belboon.com/?wsdl'); // SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true ); try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getProgramCategories( 'DE', // language 2, // categoryId null, // query array('amountofprograms' => 'DESC'), // orderBy 10, // limit 0 // offset ); echo '<pre>'; print_r($result); } catch( Exception $e ) { // Error handling here... }

4.2.7 getProgramsByCategory()

Request Parameter

Name	Type	Default	Description
categoryId	Integer	0	Lists search results after this amount
adPlatformId	Integer
orderBy	String[] (Array)	array('programname' => 'ASC')

Response (handler)

Index	Type	Description
programid	Integer	ID of the Partner programs
programname	String	Name of the Partner programs
programlanguage	String {DE, EN, FR, NL, ...}	Program Language
programdescription	String	Program Description
programterms	String	Program Terms
advertiserurl	String	Merchant URL
programlogo	String	Partner Program Logo URL
programregisterurl	String	Partner Program Registration Page URL
partnershipstatus	String {AVAILABLE, PENDING, PARTNERSHIP, REJECTED, PAUSED}	Partnership Status
partnershipid	Integer	Partnership ID - when partnership is active
programcurrency	String {EUR, GBP, USD, ...}
commissionviewmin	Float	Minimum View commission in Program currency
commissionviewmax	Float	Maximum View commission in Program Currency
commissionclickmin	Float	Minimum Click commission in Program Currency
commissionclickmax	Float	Maximum click commission in Program Currency
commissionleadmin	Float	Minimum Lead commission in Program Currency
commissionleadmax	Float	Maximum Lead commission in Program Currency
commissionsaleminfix	Float	Minimum fixed Sale commission in Program Currency
commissionsalemaxfix	Float	Maximum fixed Sale commission in Program Currency
commissionsaleminpercent	Float	Minimum Percent Sale commission in Program Currency
commissionsalemaxpercent	Float	Maximum Percent Sale commission in Program Currency

Example:

<?php define('WSDL_SERVER', 'http://api.belboon.com/?wsdl'); // SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true ); try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getProgramsByCategory( 2, // categoryId <YOUR_AD_PLATFORM_ID>, // adPlatformId array('commissionleadmax' => 'DESC') // orderBy ); echo '<pre>'; print_r($result); } catch( Exception $e ) { // Error handling here... }

4.2.8 searchCommonAds()

Request Parameter

Name	Type	Default	Description
adPlatformIds	Integer[] (Array)
hasPartnership	Boolean
programId	Integer		Lists only the programs advertising material with the Program ID
adType	String {IMAGE, TEXT, FLASH, HTML, NEWSLETTER_TEMPLATE, BANNER_GENERATOR, MOBILE_AD, MOBILE_TEXT, MOBILE_BANNER_GENERATOR, PAGE_PEEL}	null	Lists only the advertising material of the selected type
adWidth	Integer	null	Width of the banners by adType IMAGE and FLASH
adHeight	Integer	null	Height of the banners by adType IMAGE and FLASH
orderBy	String[] (Array)	array( 'platformid' => 'ASC', 'programid' => 'ASC' )	Orders the return of the events according to the passed column name with the desired orientation (ASC = ascending, DESC = descending)
limit	Integer	null	Limits the number of results to this max value
offset	Integer	0	Lists results from this value

Response (handler)

Behind the property handler lies the Result-object, an object, with a single publicly visible property that bears the name of the commonAds. It contains a numerically indexed array of 0 or more rows (arrays), each of which is structured as follows:

Index	Type	Description
programid	Integer	Partner Program ID
programname	String	Name of the Partner Programs
platformid	Integer
platformname	String
adid	Integer	Advertising Material ID
adname	String	Advertising Material Name
adtype	String {IMAGE, TEXT, FLASH, HTML, NEWSLETTER_TEMPLATE, BANNER_GENERATOR, MOBILE_AD, MOBILE_TEXT, MOBILE_BANNER_GENERATOR, PAGE_PEEL}	Advertising Material Type
adwith	Integer	Width of the banners by adType IMAGE and FLASH
adheight	Integer	Height of the banners by adType IMAGE and FLASH
viewimgurl	String	URL of the View image pixel byi adType TEXT, IMAGE, MOBILE_AD and MOBILE_TEXT
linkurl	String	Link-URL by adType TEXT, IMAGE, MOBILE_AD and MOBILE_TEXT; URL to Bannergenerator by adType BANNER_GENERATOR and MOBILE_ BANNER_GENERATOR
linktext	String	Link-Text by adType TEXT and MOBILE_TEXT
adcodecomplete	String	Complete Advertising Material Code

Example:

<?php define('WSDL_SERVER', 'http://api.belboon.com/?wsdl'); // SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true ); try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->searchCommonAds( array(<ID_1>, <ID_2>, ...), // adPlatformIds true, // hasPartnership null, // programId 'IMAGE', // adType null, // adWidth 60, // adHeight array('adwidth'=> 'ASC'), // orderBy 10, // limit 0 // offset ); echo '<pre>'; print_r($result); } catch( Exception $e ) { // Error handling here... }

5 Change-log

Changes from V.1.0 to V.1.1

Function „getProgramConditionDetails“ added

Attachments:
DE_Publisher_Handbuch Webservices Partnerprogramme V1.1 - (Size 742kb)
DE_Publisher_Handbuch_Webservices_Partnerprogramme_V1_1.pdf - (Size 742kb)
EN_Publisher_Handbook_Webservices_PartnerPrograms_V1_1.pdf - (Size 737kb)

Meld u nu aan!

Maak deel uit van ons uniek succesverhaal!

Publisher: aanmelden

Phone: 0049 (0)30-72 61 62 320
Fax: 0049 (0)30-72 61 62 311
Email: info@belboon.nl

Advertiser: meer

belboon-adbutler GmbH
Karl-Liebknecht-Str. 1
10178 Berlin
Duitsland

Phone: 0049 (0)30- 72 61 62-320
Fax: 0049 (0)30 - 72 61 62-311
Email: info@belboon.nl

Kamer van Koophandel:
AG Berlin (Charlottenburg), HRB 125210
VAT-ID: DE220719614

Managing Director (CEO): Manuel Kester

SVEN POHLMANN
boniad Medienagentur

"Het belboon partner netwerk ontwikkelde zich spoedig tot de nummer 1 voor ons bedrijf. De prima programmakeuze, aantrekkelijke reclames en competente steun van de affiliates heeft ons overtuigd. [...]"