Request body

token
string
identifikátor e-shop
version
intiger
apiUser
string
uživatelský přistup do API e-shop
apiKey
string
uživatelské přistupové heslo do API e-shopu
apiUrl
current_admin_language
enum
Jazyk administrace podle ISO 639-1

cs
Čeština
string
sk
Slovenština
string
en
Angličtina
string
signature
string
base64_encode podpis specifikovaných atributů pomocí privatního klíče
POST https://vasedomena.com/vášInstalačníAPIEndoint JSON

{
"token": "",
"version": "",
"apiUser": "",
"apiKey": "",
"apiUrl": "",
"current_admin_language": "cs",
"signature": ""
}
                                        

Response body

error
required
boolean
true / false, 1 / 0
message
string
potřebné pokud je error = TRUE.
{} Response JSON

{
"error": false,
"message": ""
}
                                            

Podpisový vzor:

{} Signature PHP

<?php

$data = implode(";", [
    "token" => "...",
    "apiUser" => "...",
    "apiKey" => "...",
    "apiUrl" => "https://...",
    ]);
$signature = 'a0e0a3e7689bd4c80e4d6ffcccb05235b864e1d0';
$signaturePublicKey = file_get_contents("https://files.upgates.com/addons/signature/api.signature.pub.key");
$verify = openssl_verify($data, base64_decode($signature), $signaturePublicKey, OPENSSL_ALGO_SHA256);
            
        

Neúspěšná instalace

  • Doplněk nelze aktivovat, pokud:
    • Vaše odpověď je delší než 5 vteřin.
    • Jakákoliv jiná odpověď než se stavovým kódem HTTP 200.
    • Odpověď HTTP 200 není validní.

Odpověď (Validace)

  • required attribut error
    • TRUE (bool) - Problém na straně doplňku - instalace by proběhla v pořádku, ale zákazník musí před instalací splnit dodatečné podmínky, než bude moct nainstalovat doplněk.
    • FALSE (bool) - Vše proběhlo v pořádku, doplněk je úspěšně nainstalován.