Installing the addon

In the following section, we assume that you have set up a partner e-shop and that you are an approved Shoptet API partner. For example partner e-shop URL shall be <a href="https://12345.myshoptet.com">https://12345.myshoptet.com</a>.

Terms Used

OAuth Access Token This string represents each individual installation of your addon at the e-shop and it is necessary to gain an API access token. It is therefore unique for each e-shop and addon. It has an unlimited duration. 255 characters long. The OAuth Access Token must not leave the backend developer. Do not send it to the e-shop operator, to backend, or in an e-mail.

code String sent as a GET parameter to your URL, which was entered in the addon settings. Time limited validity.

API access token String to access the Shoptet API. Time limited validity of 30 minutes. 255 characters long. You can gain an API access token by calling the authorized requirement on the OAuth server. Authorization is carried out using the OAuth Access Token, which you get from the process of installing the addon using the e-shop. A maximum of 5 simultaneously valid API access tokens (per single OAuth Access Token) can be requested.

Obtaining OAuth Access Token

For each individual installation of the addon, you need to gain an OAuth Access Token value and securely save it in your data structures. The OAuth Access Token therefore uniquely identifies the e-shop and the addon. The OAuth Access Token is only acquired once for each e-shop and addon during installation.

Process of obtaining the API access token:

When installing the e-shop, you will receive a http request containing the code GET parameter. The URL, to which these requests with the code are to be sent, is entered in the addon settings. (Partner e-shop Administration → Connections → API Partner → Addons tab). URLs with 80, 8080, 443, and 8443 ports are permitted.
Use the code value to authorize you with the OAuth server. In response, you will receive an OAuth Access Token to be used to get the API access tokens.

Attention: The HTTP status of your server’s response to the code request if installation is successful must be 200. If your server does not respond with status 200, we consider the installation process to have been unsuccessful. Installation calls from Shoptet will only be sent from IP addresses 78.24.15.64/26 or 93.185.110.117/28.