Allegro WebAPI

Programming interface of the Allegro platform

Application guidelines

Here you can find guidelines helping your application meet the Allegro expectations.

Rules, service page, general remarks

  1. Each application running on Allegro WebAPI should follow the rules of WebAPI User Agreement, Allegro User Agreement and Polish law.
  2. Allegro WebAPI service is the only recommended and supported access method to resources and mechanisms of the e-commerce platform belonging to the Allegro Group. Parsing websites (web scraping) or e-mails and using any other techniques opening automatically access to resources of the platform in order to use them, omitting the Allegro WebAPI service is unwelcome.
  3. In case of any problems with writing the code you can always ask for help on the Allegro WebAPI forum. Allegro employees responsible for WebAPI as well as experience programmers are always willing to help.

Passwords, security, sensitive data

  1. Distribution of software that requires providing a username and a password of a user different then the software's author requires consent of the Allegro Group (V.3. of the WebAPI User Agreement). In order to receive such consent, please contact us using the contact form.
  2. Passwords and user data of users using e-commerce platforms belonging to the Allegro Group should not be stored on application's server or in the application itself.
  3. If the mechanism of the application requires storing sensitive data on the server or in a local database, then data must be stored in the encrypted form. Users should be informed about that fact. The application and its author is responsible for security of stored data.
  4. The logging in form presented in the application should:
    • mask password,
    • inform that username and password are used only to communication with Allegro (or other e-commerce platform belonging to the Allegro Group) and will never be used otherwise.
  5. The application's user should always have the possibility to delete his/her account from the server or local database and all data related to him/her and his/her trading partners.

Keys, access

  1. The application should work using one particular WebAPI key.
  2. The key used by it should be hidden in the code and work in a way unnoticed by the user.
  3. Value of the key assigned to the application should not be displayed to the application's user. Also, it should not be pass to unauthorized persons.
  4. You should not force users to generate their own WebAPI keys in order to use your software.

Technical, optimization, good practice

  1. In order to provide full compatibility with webservices of e-commerce platform belonging to the Allegro Group, we recommend using the UTF-8 character encoding.
  2. Error messages should be user-friendly. The application instead of an error code should present a message about an error in the fault-string field.
  3. We recommend maximum optimization of the application taking into account the number of particular method calls, used resources and traffic volume spread in time. In particular:
    • you should be sure, you use only those methods that are necessary to obtain desired data,
    • please remember that responses to particular actions can be optimized thanks to use of mechanisms available via event journals,
    • when WebAPI server returns the error code as a response to an action, we recommend setting a limit to automatic attempts of the same action to 4-5. Passing the same parameters in a never ending loop is useless, may lead to block and should be processed in the code by an appropriate exception.
  4. Changes to category tree and/or sale form fields should be processed by the application and particular components should be refreshed automatically or marked as possible to be refreshed by the application's user each time the change of version key in the given country is detected.
  5. We recommend that you use the license mechanism (key) to limit access to your application only to selected users (e.g. those who have paid for it). This mechanism works entirely on Allegro side.
  6. In case of paid applications please think about their free demo versions. That allows the potential future customers to test the software (time- or function-limited) before making the purchase decision.

Last update: 19.03.2012