Skip to main content

Setting up REST API

The term REST API is made up of two acronyms. REST stands for Representational State Transfer, API for application programming interface. Essentially this means that you can use external calls to communicate with your plentymarkets system in certain ways. This allows you to, for example, retrieve the data of all your contacts at once.

Even if you do not intend to use REST API in general, you may still want to use plugins that utilize these so-called routes to interact with your system. Some examples include eBay OAuth2 and Etsy. For these plugins to work properly, you must grant them certain permissions.

1. For end users

If you want to use plugins that require REST routes, you must grant them permission to access certain parts of your system. To do so, first create a new user of the class Variable.

Creating a Variable user account:

  1. Go to System » System settings » Settings » User » Accounts.

  2. Click on New.
    → The Create new user window opens.

  3. Enter the User name.

  4. Enter the Real name.

  5. Enter the Password.

  6. Repeat the password.

  7. Select the User class Variable.

  8. Save the settings.

The user name must not contain any spaces and must have at least 5 characters.

You can specify which rights to grant the user in the REST API tab of the user’s account settings. No REST API rights are activated by default. Rights are granted separately for different modules and sub-modules of the REST API. Under Authorisation, for example, you define whether the REST API user account can display rights or display, create and delete user roles.

Activating REST API areas:

  1. Go to System » System settings » Settings » User » Accounts.

  2. Open a user account.

  3. Click on the Right tab.

  4. Click on the REST API tab.

  5. Activate entire areas or expand areas to activate individual rights that the user account should have access to.

  6. Save the settings.

Subsequently added, subordinated rights of a main module will be activated automatically for a user account if the main module is activated. You can deactivate this function and manually activate new, subordinated rights.

Manually activate new, subordinated rights:

  1. Go to System » System settings » Settings » User » Accounts.

  2. Open a user account.

  3. Click on the Right tab.

  4. Click on the REST API tab.

  5. Click on Activate new, subordinated rights manually.

  6. Save the settings.

For information on which rights to grant an account, see the plugin’s user guide.

2. For developers

If you are interested in developing and selling a plugin that utilizes REST API, you can upload it to the plentyMarketplace free of charge. In addition to plentymarkets plugins, it is also possible to integrate external offers. Register here to become a partner.

See our developers site for general information on the plentymarkets REST API as well as the available routes. You can also check our tutorials for some examples of how to implement them:

To top