Rechercher Bannière
| F.A.Q. |
a. Business API Introduction
API Key
In order to use the API, you need an API key. The API key is required to do any query through the API. You can get an API key by going to the “Affiliation” section of your account and completing the API form. Currently there is only one API key available : Business API key. Take a look at the chart below to review the methods available to you. It is possible to have multiple API keys. Each application created must be associated with a different API key.
Term of Use
The API terms of Use governs the rights and conditions in which each API may be used. Please review the API Term of Use for the appropriate API before using it.
Encoding
The Abracadaban API requires all data to be UTF-8 encoded. More information about UTF-8 encoding
Authentication
Some methods need to be authenticated (see table below). The process of authentication is equivalent to login process to the Abracadaban website. The login and password must be sent securely through the API and when authenticated a session ID will be provided. This session ID will then be needed to use methods with authentication. For more information about authentication, please take a look at method loginUser method.
Methods
Methods make it possible to execute different functions through the API. The following table gives information about the methods available within each API Type. Other methods will be soon be added.
| Methods | Business API | Authentication | Description |
|---|---|---|---|
| Search | |||
| getSearchResults |  |
no | full search capabilities |
| getCategories | |
no | return categories |
| getTags | |
no | return tag cloud |
| getCountries | |
no | return countries list |
| getBestSales | |
no | return best sales |
| getLastIndexed | |
no | return last indexed banner |
| Banner Template | |||
| getBannerDetails | |
no | return all information about a banner |
| getBannerCategories | |
no | return categories attached to a banner |
| getBannerTags | |
no | return tags attached to a banner |
| getBannerSimilar | |
no | return similar banners |
| getBannerOtherSize | |
no | return other sizes attached to a banner |
| User | |||
| createUserAccount | |
yes | create user account |
| loginUser | |
yes | log a user (needed for authentification) |
| logoutUser | |
yes | log out a user (kill session) |
| getUserAccount | |
yes | return information about the logged user |
| getUserAds | |
yes | return purchased Ads list attached to the logged user (Title, Desc, Size and HTML code) |
| getUserAdCode | |
yes | return HTML code for a purchased Ad |
| getUserReports | |
yes | return purchased Ads reports for the period |
| getUserBanners | |
yes | return banner templates list attached to the logged user |
| getUserEarnings | |
yes | return earnings information about the logged user |
| getUserCredits | |
yes | return credits information about the logged user |
| creditPurchase | |
yes | return credits information about the logged user |
| General Tab | |||
| setGeneralTab | |
yes | This method allows you to customize general tab of your banner |
| setPictureTab | |
yes | This method allows you to customize picture tab of your banner |
| setVideoTab | |
yes | This method allows you to customize video/music tab of your banner |
| setEffectTab | |
yes | This method allows you to customize effect tab of your banner |
| setTextTab | |
yes | This method allows you to customize text tab of your banner |
| setSavePublishTab | |
yes | This method allows you to save and publish your customized banner |
| setGifGeneralTab | |
yes | This method allows you to customize general tab of your gif banner |
| setGifEffectTab | |
yes | This method allows you to customize effect tab of your gif banner |
| setGifTextTab | |
yes | This method allows you to customize text tab of your gif banner |
| setGifSavePublishTab | |
yes | This method allows you to save and publish your customized gif banner |
| clearShoppingCart | |
yes | This method allows you to clear your shopping cart list |
Query Format
XML/RPC
XML/RPC format is available for query/response. XML-RPC is a Remote Procedure Calling protocol that works over the Internet. An XML-RPC message is an HTTP-POST request. The body of the request is in XML. A procedure executes on the server and the value it returns is also formatted in XML. more information about XML/RPC
