Addons documentation
... WIP articles ...
Basic information about API
The Shoptet API offers a wide range of integration and automation possibilities. In this article, we’ll take a look at what the Shoptet API can do, how it works, and how to get started – from access tokens to the basic principles of communication.
Installing the addon
Installing an addon is a crucial step in the integration process. This article explains how to install an addon, set up the necessary permissions, and ensure a smooth installation process.
Getting the API access token
To access the Shoptet API, you need an access token. This article explains how to obtain the token and use it to authenticate your API requests.
Product images
Product images are an essential part of any e-shop. This article explains how to work with product images in Shoptet API.
Webhooks
Webhooks in the Shoptet API send notifications about important events, reducing the need for frequent API polling. This guide explains how to set up, manage, and handle webhooks efficiently to ensure seamless data synchronization.
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.
Uninstalling the addon
What to do when the addon is uninstalled? This article explains the uninstallation process, how to recognize it, and how to use the uninstaller webhook.
Pausing/resuming the add-ons
Do you want to know why add-on can be paused/resumed and how to setup URLs for webhook notifications to prevent rejected API requests?
E-shop verification using OAuth
If you need to save settings for each add-on installation, the Shoptet OAuth server can verify the e-shop administrators' identity. This eliminates handling user passwords and allows e-shop operators to use their existing Shoptet credentials.
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.
Asynchronous Requests
Asynchronous requests allow you to perform long-running operations without blocking the main thread. This article explains how to use asynchronous requests in the Shoptet API, including best practices and examples.
Proper API usage
Efficient use of APIs improves the performance of integrations and reduces the load on the server. By following best practices such as working with snapshots, webhooks, and batch processing, you ensure your applications run smoothly and seamlessly.
Private API tokens maintenance
For Premium e-shops, a screen in the administration allows you to maintain your tokens for Private API. You can find it
in the Connections → Private API.
To be updated by the API team.