Allegro WebAPI

Programming interface of the Allegro platform

General information

General information on Allegro WebAPI making it easier to start using the service.


WebAPI in a nutshell

Allegro WebAPI is a service allowing to access resources and platform's logic without the mediation of an interface layer. The service is dedicated to developers interested in building their own solutions using data and mechanisms shared by the platform.
 
The following simplified scheme presents the API mechanism:
 

Schemat przedstawiający metodę działania usługi Allegro WebAPI

Allegro WebAPI is a web service based on the SOAP protocol and using the XML language as a format of creating messages as well as the RPC protocol to transfer them between the client (application) and the WebAPI server.

Detailed description of the service is defined using the WSDL language and can be found here (available only via encrypted channel): https://webapi.allegro.pl/service.php?wsdl

Using the RPC protocol determines the network's architecture. Allegro WebAPI consists of methods reflecting functions available in the service. By using our API you can:
  • list offers on Allegro,
  • list offers listed in selected categories and by given users,
  • manage searcher,
  • view information on listed offers,
  • load contact data of users who bought items in offers of the selected user,
  • list and leave feedback for you trading partners,
  • load content of the selected My Allegro tabs,
  • place bids,
  • manage the commission refund system available on the platform,
  • load information on status of payments made via PayU.

Allegro WebAPI is a multi-language and a multi-platform service. By setting the methods appropriately you can also manage international Allegro counterparts (Aukro.cz, Aukro.ua, Molotok.ru, etc.) and all returned information (including error messages) will be translated into languages of the selected countries.



Keys

The service is free of charge for all users (no account block and full account activation are required) requesting for access key via the contact form (each key is valid for one year from the date of its creation; one week before expiration date a reminder is sent).

Granting access to the service means generating a unique and fixed Allegro WebAPI key for the given account. The key identifies the user within the service. The API key is assigned to the given account on the moment of generating it, but it does not mean that only this account can use it. Each Allegro user who knows the API key of other user can use it, and has the access to the service (III.2. WebAPI User Agreement regulates the scope of responsibility in such case). Therefore we recommend not to share the key value directly with others. In order to be sure that no unauthorized persons use your key, enable its license mechanism.

Please remember that API keys are case sensitive – providing X123Y456Z instead of x123y456z results in returning the message about incorrect key value.

When the API key is generated, the user receives set of version keys (with unique values within each API key) – one for each country where API is available (currently 10 – including test platform). Value of version keys, unlikely the API key, changes each time when some dynamic components are updated because of their nature (usually it relates to the category tree structure and sale form fields). The event of key change is reported by the service via the specially prepared error code (ERR_INVALID_VERSION_CAT_SELL_FIELDS). Dates of recent updates of mentioned components can be checked in the lower part of the main page on the service information page.

To sum up:

  Allegro WebApi Key
Version keys
Role Service access
Informing about changes in components
Number of keys 1 10
Fluctuation No Yes
Value preview
My Allegro > WebAPI
My Allegro > WebAPI + dedicated API methods



Additional tools

Owners of WebAPI keys get additionally access (via: My Allegro > WebAPI) to two special tools handful with day-to-day service use. These are:

  • Statistics, in a form of diagrams presenting number of all method calls divided into countries/platforms. They have 7-month scope (including current month) and are weekly summarized. Apart from statistics for each method, there are also data presenting 10 most frequently used methods (also divided into countries/platforms).

Przykładowy wykres dostępny w statystykach WebAPI

  • License mechanism, allows for managing the temporary access to application based on the API key assigned to the account. The access is granted to a selected group of users.Formularz dodawania użytkownika w ramach mechanizmu licencjonowania Allegro WebAPI In other words – this is the mechanism that allows for creating white lists containing manually verified users. It can be used to manage the application access (it is more reliable than the similar solution built on client's side, as it is resistant to reverse engineering attempts – the mechanism runs entirely on Allegro servers). Additionally it is possible to manage the mechanism by using dedicated API methods.






Developer’s WebAPI Sandbox


To enable users to test our API outside the production development, we have set up an isolated Sandbox development environment that makes it possible to safely test apps built with the APIs of Allegro.pl and Aukro.cz. The environment duplicates the key functionalities available on websites operating on the Allegro platform and enables simulations of payments via the PayU system. With the Sandbox you can:
  • listing offers,
  • list offers listed in selected categories and by given users,
  • searcher management,
  • view information on listed offers,
  • list and leave feedback for you trading partners,
  • load content of the selected My Allegro test tabs,
  • placing bids.
Most importantly, all the operations in the Sandbox environment are free of charge and are not limited by the bans and restrictions specified in the Allegro User Agreement, and thus applicable for the production environment. For more information on WebAPI Sandbox, go here.


Last update: 09.11.2016