Add-on activation
Request body
token
string
e-shop identifier
version
intiger
Add-on version identifier
apiUser
string
user access to the e-shop API
apiKey
string
user access password to the e-shop API
apiUrl
string
API URL of eshop. It is not unique and can change. We do not recommend using it for user matching.
current_admin_language
time
string
Signature validity time_v2 by ISO 8601
signature_v2
string
base64_encode signature of specified attributes using private key
To create it, you will need to know signature_token.
To create it, you will need to know signature_token.
POST https://yourdomain.com/yourinstallationAPIEndoint JSON
{
"token": "",
"version": 0,
"apiUser": "",
"apiKey": "",
"apiUrl": "",
"current_admin_language": "cs",
"time": "",
"signature_v2": ""
}
Response body
error
required
boolean
true / false, 1 / 0
message
string
required if error = TRUE.
{} Response JSON
{
"error": false,
"message": ""
}
Signature specimen
You can learn what a signature is and why it is used here.
signature_token is a special identifier for your add-on. You can find it in Marketplace / Add-on details - Add-on development (read more)
{} Signature_v2 PHP
<?php
$data = implode(";", [
"token" => "...",
"apiUser" => "...",
"apiKey" => "...",
"apiUrl" => "https://...",
"time" => "...",
"signature_token" => "...",
]);
$signature_v2 = 'a0e0a3e7689bd4c80e4d6ffcccb05235b864e1d0';
$signaturePublicKey = file_get_contents("https://files.upgates.com/addons/signature/api.signature.pub.key");
$verify = openssl_verify($data, base64_decode($signature_v2), $signaturePublicKey, OPENSSL_ALGO_SHA256);
Failed installation
- The add-on cannot be activated if:
- Your answer is longer than 5 seconds.
- Any response other than HTTP status code 200.
- HTTP 200 response is not valid.
Answer (Validation)
requiredattributerrorTRUE(bool) - Problem on the add-on side - installation would be fine, but the customer has to meet additional conditions before they can install the add-on.FALSE(bool) - Everything went fine, the add-on is successfully installed.
- cURL supported content encoding
- libcurl
- deflate
- gzip
- br
- zstd
Changelog
| Datum | Typ | Změna |
|---|---|---|
| 01.01.2025 | signature |
the signature has been removed and replaced with a new version signature_v2 |
