Accueil | Offres d'emploi | FAQ | Mentions Légales | CGV | Politique de confidentialité (Privacy policy)
ÉDITEURANNONCEURAGENCESPROGRAMME D’AFFILIATIONAPPS & APIPRESSEA PROPOS

SmartFeed SOAP-WebServices V1.4.1

 

1 Content

1 Content
2 Introduction
3 Generating A WebService Password
4 SmartFeeds-Webservices
4.1 Result-Object
4.2 Config-Array
4.3 Functions
4.3.1 Session / Authentification
4.3.1.1 login (username, password)
4.3.2 Partnership-Data
4.3.2.1 getPlatforms (SessionHash)
4.3.2.2 getFeeds (SessionHash, [config])
4.3.3 Product-Data
4.3.3.1 getProductData (SessionHash, [config])
4.3.3.2 getFeedUpdate (SessionHash, FeedId)
4.3.3.3 searchProducts (SessionHash, Query, [config])
4.3.3.4 getProductById(SessionHash, productId)
4.3.3.5 searchProductsByEan (SessionHash, EAN, [config])
4.3.3.6 getCategory($sSessionHash, $iCategoryId)
4.3.3.7 getCategories($sSessionHash, $aConfig)
4.3.3.8 getCategoryPath($sSessionHash, $iCategoryId)
4.3.3.9 logout (sessionHash)
5 Change-log

 

2 Introduction

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



Using the belboon SmartFeeds-Webservice API you can access the datafeeds of belboon Merchants fully automatically. More than 500 online shops offer you many million products through the product databank. In order to access the datafeeds of the relevant merchants, you must have an active partnership to the programs.


A condensed overview of all merchants with datafeeds can be seen in the menu: “Overview Datafeeds”. You can use the SmartFeeds-Webservices to download datafeeds, category structures, individual shops, product search results and much much more.

SmartFeeds-WebService-URL: http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl

 

 

3 Generating A WebService-Password

The SmartFeeds-Webservices Using you can access the datafeeds of belboon Merchants without having to login to your belboon account.

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

 

 

4 SmartFeeds-Webservices

4.1 Result-Object

Upon calling up the webserivces function, the data will be delivered back over a uniform "Result-Object". This object contains several Meta data, for example: error messages and an Array of the called upon data.

 

Result-Object

ParameterTypeDescription

hasError

Boolean

Shows if an error occurs: true/false

ErrorMsg

String

optional error-massage

NumRecords

Integer

number of rows of the result-array

NumRecordsTotal

Integer

total number of rows for the request

Records

Array()

list of requested objects

» Content

4.2 Config-Array

Some function calls can be passed alongside the sessionhash and where applicable a search for an array of configuration parameters. With help of the Arrays, diverse filters can be set.

What values that can be passed in this Array, please refer to the descriptions of each function.

KeyTypeDefaultDescription

platforms

Integer[] (Array)

Null

limits the results to data of partnerprograms where a partnership with this adplatform-ID exist

feeds

Integer[] (Array)

Null

limits results to datafeeds with the provided IDs

offset

Integer

0

gives back search result starting at the offset

limit

Integer

Null

limits results to the provides number of datasets

updated_after

Date

1970-0-0

returns only data, that were updated after the provided date

categories

Integer[] (Array)

Null

limits the results to data that are in the provided belboon-categories

sort

String[]
(Array)

array(„belboon_productnumber" => „ASC")

returns sorted data (for product-searches or feed-search) by the given datafield-name ascending or descending (ASC or DESC)

price_min

float

0.00

minimum  price

price_max

float

999999.99

maximum  price

categories

Integer[] (Array)

Null

Filters results to categories with the requested category-IDs. *not all available products are matched to a belboon-category

with_subcategories

Boolean

True

Delivers also product-results from sub-categories if category-filter is used. Standard: activated/yes (=TRUE).

» Content

4.3 Functions

4.3.1 Session / Authentification

4.3.1.1  login (username, password)

When a session hash value delivers [string ()] back, valid for 30 minutes, with the end of the 30 minutes with each new action / query starts again. For each individual query the session hash is delivered as authentication.

 

Request

ParameterTypeDescription

username

String

Username / Login

password

String

Webservice-password

 

Response-Parameter

ParameterTypeDescription

sessionHash

String

SessionHash for identification and to use in the following requests

 

Example:

 

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed=new SoapClient(WSDL_SERVER);

  $oSessionHash=$oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

            $sSessionHash=$oSessionHash->Records['sessionHash'];

  }

» Content

4.3.2 Partnership-Data

4.3.2.1 getPlatforms (SessionHash)

Returns a list (Array) all advertising platforms of ones account.

Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

 

 

 

Response-Parameter

ParameterTypeDescription

id

Integer

AdPlatform-ID

name

String

AdPlatform-Name

 

 

 

 

Example:

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

            $sSessionHash=$oSessionHash->Records['sessionHash'];

            $aResult=$oSmartFeed->getPlatforms($sSessionHash);

            var_dump($aResult);

  }

» Content

4.3.2.2 getFeeds (SessionHash, [config])

Returns a list (Array) all datafeeds of the programs, with an active partnership, where necessary limited with a filter.

Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

[config]

Array

Config Array, optional

 

 

 

Config-Array

KeyTypeDefaultDescription

offset

Integer

0

gives back search result starting at the offset

limit

Integer

Null

limits results to the provides number of datasets

platforms

Integer[] (Array)

 

limits the results to data of partnerprograms where a partnership with this adplatform-ID exist

sort

String[]
(Array)

array(„belboon_productnumber" => „ASC")

returns sorted data (for product-searches or feed-search) by the given datafield-name ascending or descending (ASC or DESC)

 

 


 

Response-Parameter

ParameterTypeDescription

id

Integer

Ad-/Feed-ID of the product-datafeed

name

String

Ad-/Feed-Name

product_count

Integer

Number of products

last_update

String (YYYY-MM-DD HH:mm:ss)

Last update

program_name

String

Affiliate Program name

url

String

Shop URL

logo_url

String

Shoplogo-URL

 

Example:

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

            $sSessionHash= $oSessionHash->Records['sessionHash'];

            $aResult= $oSmartFeed->getFeeds($sSessionHash);

            var_dump($aResult);

  }

» Content


4.3.3 Product-Data

4.3.3.1 getProductData (SessionHash, [config])

Returns a list (Array) of all productdata, optional filtered by the config-array restrictions.

 

Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

[config]

Array

Config Array, optional


Config-Array

KeyTypeDefaultDescription

platforms

Integer[] (Array)

Null

limits the results to data of partnerprograms where a partnership with this adplatform-ID exist

feeds

Integer[] (Array)

Null

limits results to datafeeds with the provided IDs

offset

Integer

0

gives back search result starting at the offset

limit

Integer

Null

limits results to the provides number of datasets

updated_after

Date

1970-0-0

returns only data, that were updated after the provided date

sort

String[]
(Array)

array(„belboon_productnumber" => „ASC")

returns sorted data (for product-searches or feed-search) by the given datafield-name ascending or descending (ASC or DESC)

categories

Integer[] (Array)

Null

Filters results to categories with the requested category-IDs. *not all available products are matched to a belboon-category

with_subcategories

Boolean

True

Delivers also product-results from sub-categories if category-filter is used. Standard: activated/yes (=TRUE).

 

 

Response-Parameter

ParameterTypeDescription

feed_id

INT

ID of the productdata-feed

belboon_productnumber

String

belboon product-ID

belboon_programid

String

partnerprogram-ID

productnumber

String

merchant product-number

ean

String

EAN-Code

productname

String

Product-name

manufacturername

String

Manufacturer

brandname

String

Brand

currentprice

String

Current price

oldprice

String

Old price

currency

String

Currency

validfrom

String

Start-date for this offer

validuntil

String

End-date for this offer

deeplinkurl

String

Deeplink product-URL

basketurl

String

URL for putting the product directly into the shopping cart

imagesmallurl

String

URL of "small" product-picture

imagesmallheight

INT

Height of "small" product-picture

imagesmallwidth

INT

Width of "small" product-picture

imagebigurl

String

URL of "big" product-picture

imagebigheight

INT

Height of "big" product-picture

imagebigwidth

INT

Width of "big" product-picture

productcategory

String

Product-Category of the merchant

belboonproductcategory

String

belboon product-Category

productkeywords

String

Keywords

productdescriptionshort

String

Short product description

productdescriptionlong

String

Long product description

Lastupdate

String

Last Update of the productdata (provided by the merchant)

shipping

String

Shipping costs

availability

String

Availability of the product

option1

String

Optional field / additional information

option2

String

Optional field / additional information

option3

String

Optional field / additional information

option4

String

Optional field / additional information

option5

String

Optional field / additional information

 

 

Example:

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

            $sSessionHash= $oSessionHash->Records['sessionHash'];

      $aConfig= array('limit'=>5, 'offset'=>2);

$aResult= $oSmartFeed-> getProductData ($sSessionHash, $aConfig);

            var_dump($aResult);

  }

» Content

4.3.3.2 getFeedUpdate (SessionHash, FeedId)

Returns the date and time of the last datafeed-update by the advertiser for a requested datafeed.


Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

FeedId

Integer

Feed-/Ad-ID of datafeed for which the last-update date should be returned.

 

 

Response-Parameter

ParameterTypeDescription

last_update

Date

Last datafeed-update by the advertiser

 

Example:

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

            $sSessionHash= $oSessionHash->Records['sessionHash'];

$aResult= $oSmartFeed-> getFeedUpdateDate($sSessionHash, FeedId);

            var_dump($aResult);

  }

» Content

4.3.3.3  searchProducts (SessionHash, Query, [config])

Returns a list (Array) of productdata that match to the search-term and the config-filter.

 

Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

query

String

Search-term

[config]

Array

Config Array, optional


Config-Array

KeyTypeDefaultDescription

platforms

Integer

Null

limits the results to data of partnerprograms where a partnership with this adplatform-ID exist

feeds

Integer[] (Array)

Null

limits results to datafeeds with the provided IDs

offset

Integer

0

gives back search result starting at the offset

limit

Integer

Null

limits results to the provides number of datasets

updated_after

Date

1970-0-0

returns only data, that were updated after the provided date

sort

String[]
(Array)

array(„belboon_productnumber" => „ASC")

returns sorted data (for product-searches or feed-search) by the given datafield-name ascending or descending (ASC or DESC)

price_min

float

0.00

minimum-price

price_max

float

999999.99

maximum-price

categories

Integer[] (Array)

Null

Filters results to categories with the requested category-IDs. *not all available products are matched to a belboon-category

with_subcategories

Boolean

True

Delivers also product-results from sub-categories if category-filter is used. Standard: activated/yes (=TRUE).

 

Response-Parameter

ParameterTypeDescription

feed_id

INT

ID of the productdata-feed

belboon_productnumber

String

belboon product-ID

belboon_programid

String

partnerprogram-ID

productnumber

String

merchant product-number

ean

String

EAN-Code

productname

String

Product-name

manufacturername

String

Manufacturer

brandname

String

Brand

currentprice

String

Current price

oldprice

String

Old price

currency

String

Currency

validfrom

String

Start-date for this offer

validuntil

String

End-date for this offer

deeplinkurl

String

Deeplink product-URL

basketurl

String

URL for putting the product directly into the shopping cart

imagesmallurl

String

URL of "small" product-picture

imagesmallheight

INT

Height of "small" product-picture

imagesmallwidth

INT

Width of "small" product-picture

imagebigurl

String

URL of "big" product-picture

imagebigheighti

INT

Height of "big" product-picture

imagebigwidth

INT

Width of "big" product-picture

productcategory

String

Product-Category of the merchant

belboonproductcategory

String

belboon product-Category

productkeywords

String

Keywords

productdescriptionshort

String

Short product description

productdescriptionlong

String

Long product description

lastupdate

String

Last Update of the productdata (provided by the merchant)

shipping

String

Shipping costs

availability

String

Availability of the product

option1

String

Optional field / additional information

option2

String

Optional field / additional information

option3

String

Optional field / additional information

option4

String

Optional field / additional information

option5

String

Optional field / additional information

 

Example:

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

            $sSessionHash= $oSessionHash->Records['sessionHash'];

            $aConfig= array('limit'=>5, 'offset'=>2);

            $sSearch= 'ipod';

            $aResult=$oSmartFeed->searchProducts($sSessionHash,$sSearch,$aConfig);

            var_dump($aResult);

  }

» Content

4.3.3.4 getProductById (SessionHash,productId)

Returns the data of the product with the requested belboon-productId.  

Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

ProductId

String

belboon-productId

 

Response-Parameter

ParameterTypeDescription

feed_id

INT

ID of the productdata-feed

belboon_productnumber

String

belboon product-ID

belboon_programid

String

partnerprogram-ID

productnumber

String

merchant product-number

ean

String

EAN-Code

productname

String

Product-name

manufacturername

String

Manufacturer

brandname

String

Brand

currentprice

String

Current price

oldprice

String

Old price

currency

String

Currency

validfrom

String

Start-date for this offer

validuntil

String

End-date for this offer

deeplinkurl

String

Deeplink product-URL

basketurl

String

URL for putting the product directly into the shopping cart

imagesmallurl

String

URL of "small" product-picture

imagesmallheight

INT

Height of "small" product-picture

imagesmallwidth

INT

Width of "small" product-picture

imagebigurl

String

URL of "big" product-picture

imagebigheighti

INT

Height of "big" product-picture

imagebigwidth

INT

Width of "big" product-picture

productcategory

String

Product-Category of the merchant

belboonproductcategory

String

belboon product-Category

productkeywords

String

Keywords

productdescriptionshort

String

Short product description

productdescriptionlong

String

Long product description

lastupdate

String

Last Update of the productdata (provided by the merchant)

shipping

String

Shipping costs

availability

String

Availability of the product

option1

String

Optional field / additional information

option2

String

Optional field / additional information

option3

String

Optional field / additional information

option4

String

Optional field / additional information

option5

String

Optional field / additional information

 

Example:

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

    $sSessionHash= $oSessionHash->Records['sessionHash'];

    $oResult = $oSmartFeed->getProductById($sSessionHash, '1_3_37');

    var_dump($oResult);

   }

 

» Content

4.3.3.5  searchProductsByEan (SessionHash, EAN, [config])

Returns a list (Array) of datafeeds, that apply to the transferred EAN and the filter config. Request- and Result-Object correspond to those of searchProducts().

 

Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

ean

String

EAN-Code (not always available in productdata)

[config]

Array

Config Array, optional

 

Config-Array and Response-Parameter analog to 4.3.3.3 searchProducts (SessionHash, Query, [config]).

» Content

4.3.3.6 getCategory($sSessionHash, $iCategoryId)

Returns an ID based on a product category as an Array.


Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

id

Integer

Category-ID

 

Response-Parameter

ParameterTypeDescription

id

Integer

Category-ID

parent_id

Integer

ID of parent-category

name

String

Category-Name

 

Example:

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){       

$sSessionHash= $oSessionHash->Records['sessionHash'];

            $oResult= $oSmartFeed->getCategory($sSessionHash, CategoryId);

            var_dump($oResult->Records);                   

  }

» Content

4.3.3.7 getCategories($sSessionHash, $aConfig)

Returns an Array with product categories that apply to the limitations of the Config array.

Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

[config]

Array

Config Array, optional

 

Config-Array

KeyTypeDefaultDescription

offset

Integer

0

Delivers results starting at this value

limit

Integer

Null

Limits number of results to this value

parent_id

Integer

Null

Returns only categories with the requested
parent_id

 

Response-Parameter

ParameterTypeDescription

id

Integer

Category-ID

parent_id

Integer

ID of parent-category

name

String

Category-Name

 

Example:

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

            $sSessionHash= $oSessionHash->Records['sessionHash'];

            $oResult= $oSmartFeed->getCategories($sSessionHash);             

            var_dump($oResult->Records);        

  }

» Content

4.3.3.8 getCategoryPath($sSessionHash, $iCategoryId)

Returns a list (Array) of categories, that describe the path to the given category.

Request-Parameter

ParameterTypeDescription

sessionhash

String

SessionHash for identification

id

Integer

Category-ID

 

Response-Parameter

ParameterTypeDescription

id

Integer

Category -ID

name

String

Category-Name

 

Example:

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

            $sSessionHash=$oSessionHash->Records['sessionHash'];

$oResult= $oSmartFeed->getCategories($sSessionHash);

            foreach ($oResult->Records AS $aRecord) {

$oResultPath= $oSmartFeed->getCategoryPath($sSessionHash,

$aRecord['id']);

                        foreach ($oResultPath->Records AS $aElem) {

                                    echo " > ". $aElem['name'] . " (". $aElem['id'].")";

                        }

            }         

  }

» Content

4.3.3.9 logout (sessionHash)

Closes current session.

 

Request

ParameterTypeDescription

sessionhash

String

SessionHash for identification

 

Example:

 

<?php

  define ("WSDL_SERVER", 

  "http://smartfeeds.belboon.com/SmartFeedServices.php?wsdl");

  $oSmartFeed= new SoapClient(WSDL_SERVER);

  $oSessionHash= $oSmartFeed->login('YourLoginName', 'YourPassword');

  if(!$oSessionHash->HasError){

            $sSessionHash= $oSessionHash->Records['sessionHash'];

            ...

            $oSmartFeed->logout($sSessionHash);

  }

» Content

5 Change-log

Changes done from V.1.3 to V.1.4

  • Extension of the „getFeeds"-function's Response-Parameter. Parameters „product_count“, „last_update“ and „program_name“ added

 

 

Changes done from V.1.2 to V.1.3

  • Function „getProductById" added

 

 

Changes done from V.1.1 to V.1.2

  • Function „getProductData"-Response-Parameter: „belboon_programmid" corrected to „belboon_programid"
  • Function „getProductData"-Config-Array: {categories} and {with_categories} added
  • Functions „searchProducts"-Config-Array: Keys {price_min}, {price_max}, {categories} and {with_categories} added
  • Function „searchProductsByEan"-Config-Array: Keys {price_min}, {price_max}, {categories} and {with_categories} added
  • Function „searchProducts"- Response.Parameter: „belboon_programmid" corrected to „belboon_programid"
  • Function „getFeedUpdate" added
  • Function „getCategory" added
  • Function „getCategories" added
  • Function „getCategoryPath" added

 

 

Changes done from V.1.0 to V.1.1

  • Results-Object: „NumRecordsTotal" added to the Response-Parameter
  • Function „getProductsByEan" added

» Content

 

 



Piéces Jointes:
Handbuch SmartFeeds Webservices V1.4 - (Size 683kb)
FR_Affilies_Manuel_Webservices_SmartFeeds_V1_4_1 - (Size 554kb)
 

S’inscrire maintenant!

Rejoignez une équipe qui gagne!

Éditeurs: Inscription

Téléphone:  0049 (0)30-72 61 62 320
Fax: 0049 (0)30-72 61 62 311
Email: info@belboon.fr

Annonceurs: plus

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

Téléphone: 0049-(0)30 72 61 62-320
Fax: 0049-(0)30 72 61 62-311
Email: info@belboon.fr

Registre du Commerce:
AG Berlin (Charlottenburg), HRB 125210
No TVA: DE220719614

Directeur Général (CEO): Manuel Kester

SVEN POHLMANN
boniad Medienagentur

"En très peu de temps la régie d'affiliation belboon s'est développée comme notre premier générateur de revenus. Le grand choix de programmes, des bannières attractives, et un service excellent et de qualité des Affiliate Managers nous ont conquis. [...]"

twitter xing facebook rss youtube flickr