Sign in to your partner account (you will get it after signing the cooperation agreement) and you can create your own addon. If you only see a page with boxes for filling in contact information without the “addons” tab, you must fill in the information and submit it for approval, before you can see the option to create any addon.
After you create the addon, you can select the area to which the addon belongs (mandatory). At the same time, fill in your address to obtain the OAuth Codes, and you can also enter the URL address to authenticate the user, then save all the changes. The OAuth and verification addresses can even be added/edited later, when editing the addon.
After you save the addon, additional tabs appear in its detail, including the Endpoints tab. This allows you to choose what data you would like to receive from the e-shop, or possibly to change or upload. The webhooks are also available on the same tab.
It is not advisable to get all the endpoints immediately, you should only set those you really need. At the same time, the customer can see which endpoints are requested by the partner’s addon.
If you are testing the addon only within your interface, you do not need to request any approval when changing the endpoints. When you decide to publicly test your addon, you must submit the addon for approval. Once approved by Shoptet, it will be possible to install the addon (the addon will not be visible in the addon list, but only accessible via the URL, which will be visible in its detail). Once approved, any changes to endpoints/extension of rights will need to be approved.
About rights and adding endpoints. The partner – developer gets practically unlimited access to the e-shop data. This is of course a key fact and we feel obliged to inform the e-shop owners about this fact before installation at the addon page (we also check that the addon requires only the rights it truly needs). In this relation, you have great confidence from us and the e-shop owners. For example, if you find that you need an additional endpoint (access to additional data) with a new version of the addon, we must first approve it. Then the e-shop owner will be informed about such an extension of rights and it must be approved (as we are extending the “data contract”, compared to the state at the time of installation). In practice, in the e-shop administration the e-shop owner is informed that the addon calls for the extension of rights, and is encouraged to accept it.
The change of rights includes:
However, you must also take into count such a situation in which the e-shop owner has not confirmed the new rights yet, and the API returns “unauthorized access” when called by the endpoint. It is important to describe this change properly in the addon description, as well as in the release notes, to ensure that the e-shop owner does not see the requirement for further rights as an attack on their privacy, instead they understand their need for extended functionality. The e-shop owner must always accept all rights (when installing or extending rights), we do not give them the opportunity to choose between them.
If you detect missing rights (not yet confirmed by the e-shop owner), you can also forward your users directly to the addons’s rights confirmation screen using link
{domain}/admin/add-ons-manager/#modal-rights-{serviceId}
where
{domain} is the eshop’s URL{serviceId} is the internal Shoptet id of your addon, which you can easily find in your “API Partner” admin section (/admin/api-partner/?action=addons) – click on the addon line and check for ?id= parameter valueUnfortunately, during development, you need to undergo the same procedure for your e-shop – we would like to make this process more straightforward in the future, so please bear with us until then.
The newly installed addon immediately acquires all currently required rights.