Documentation

Shoptet API Starter’s guide

The technical preparation of the addon is one thing. To present it correctly to our clients is another. We can help you with that too.

Go to article

Basic information about API

Basic information about our API – it is REST, we communicate in JSON format, and you need to include an API access token in the header for authorization. It is not freely available, it can only be used by addons.

Go to article

Creating the addon

The first step to create a addon is to enter it via the GUI in your API Partner section. Here you enter labels and images, as well as various settings, including the access rights. When approving the addon, you will work with our Partner Manager, who will provide advice and approve the addon.

Go to article

Installing the addon

The user can only install the addon in the doplnky.shoptet.cz marketplace. The installation is online and the user sees the result immediately. The addon developer must write an installation routine that does the installation and obtains an access token to access the API.

Go to article

Getting the API access token

For security reasons, temporary tokens, valid for 30 minutes, are used for API calls. You must request a new one before the first call and after it expires.

Go to article

Inserting HTML codes

Both Shoptet and its API allow you to insert custom HTML into the template code, at predefined locations. Typical uses of this possibility include custom graphic editing, marketing and measurement codes.

Go to article

Webhooks

Webhooks are calls by the developer of an URL input using the HTTPS protocol, placed in the instant, when the e-shop encounters a specific event, for example the creation of a new order.

Go to article

Placing the addon settings into Shoptet administration

Instructions on how to convert a page with custom addon settings, overviews, or addon statistics directly to Shoptet administration by means of iframe. The e-shop operator can access them directly from the e-shop menu.

Go to article

Creating an order

The order creation endpoint will allow you to place a new order in Shoptet. Here you will learn more about this useful feature.

Go to article

Uninstalling the addon

The user may choose not to use the addon anymore, and uninstall it in the e-shop administration, or terminate the entire e-shop. You may need to respond to this, deactivate this user’s account and processes on your side too.

Go to article

Pausing and resuming the addon

In rare cases, a OAuth Access Token can be paused, which is a condition where the addon remains installed and billing continues, but API requests […]

Go to article

Payment gateways

The implementation of a payment gateway is a specific process that uses multiple API functions and links with Shoptet in the areas of payment methods and the order process. This article will take you through all the steps needed to implement the payment gateway.

Go to article

E-shop verification using OAuth

If you need to save the settings for individual installation of a addon, the Shoptet OAuth server can be used to identify the e-shop’s administrators. You do not have to address the user passwords, and you enable the e-shop operators to use the same credentials.

Go to article

Correct API usage

Tips on how to carefully access and use Shoptet API resources.

Go to article