Verzování doplňku

Co je to verzování

Verzování je vytvořeno pro potřeby agentury provést změny ve veřejné, anebo vývojové části samotného doplňku po jeho schválení z naší strany.

Průběh verzování

Verzování se aktivuje v případě, že je doplněk Schválený a někdo z uživatelů, popřípadě agentura samotná, změní informace v těchto dvou částech (Informace o doplňku, Vývoj doplňku).
Každou část je možné verzovat nezávisle mezi sebou.

Jakmile je agentura hotova se svými změnami, odešle změny ke schválení Upgates za pomocí tlačítka "Uložit a odeslat ke schválení".

Pokud je provedena změna ve vývojové části*, musí agentura před odesláním ke schválení vypsat, co vše se změnilo, aby zákaznici věděli, co je v aktualizaci nového. Změny se následně propíšou do detailu článku o vašem doplňku (na spodní části).

Pozor! Vámi vypsané hodnoty se po schválení verze propíšou na detail článku. Dbejte prosím tedy na prezenci textů tak, jak byste je psali svému zákazníkovi.

Jakmile bude doplněk s novou verzí schválený, všem zákazníkům odejde notifikace, že váš doplněk vytvořil novou verzi a je potřeba na ní přejít. 

* Pokud ve vývojové části měníte jen URL (aktivačního, odinstalačního a otevíracího) endpointu, anebo intervaly, již založených API enpointů, tak se možnost na přechod nové verze zákazníkům nespustí. Proběhne automaticky. Zákazník "schvaluje" přechod na novou verzi jen v takovém případě, kdy se přidává / odebírá přístup k sekci API přístupu jako takovému. Tedy například pokud jste dříve nepracovali s /categories, ale nyní je budete vyžadovat, tak toto zákazník musí schválit. Pokud ale /categories již používáte, a změníte například jen frekvenci používání, tak toto zákazník neschvaluje.

Přechod na novou verzi

Každý klient Upgates, má popsáno v nápovědě, jak na novou verzi doplňku přecházet. Tato informace mu také odchází emailem, jakmile se nová verze schválí ze strany Upgates.
Více informací o tom, jak aktualizace vypadá ze strany zákazníka, se dozvíte v tomto článku.

Pro vás, jako vývojáře, je důležité vědět, že přechod na novou verzi se provádí v seznamu doplňků tlačítkem Aktualizovat verzi.

Deaktivace staré verze

Jakmile bude doplněk s novou verzí schválený, všem zákazníkům odejde notifikace, že váš doplněk vytvořil novou verzi a je potřeba na ní přejít. Na tento přechod mají 30 dní. Pokud na novou verzi v intervalu nepřejdou, bude jejich doplněk deaktivován.

Jak zjistit verzi doplňku?

Seznam doplňků

1. Přejděte do sekce Doplňky / Moje doplňky
2. Vyhledejte příslušný doplněk.
3. Na řádku s daným doplňkem najděte sloupec Verze a v něm najdete aktuální verzi vašeho doplňku.

Detail doplňku

1. Přejděte do sekce Doplňky / Moje doplňky
2. Vyberte příslušný doplněk.
3. V sekci Hlavní najdete seznam verzí pro veřejnou a vývojovou část (pokud je doplněk má).

Identifikace použité verze u zákazníka

Díky atributu version můžete zjistit, jakou přesně verzi vašeho doplňku zákazník využívá a tím následně například posílat do iframe správné informace.
Číslo verze se vždy zvyšuje s novou verzí doplňku. Schválením se z něj nestává opět verze 1. Každá verze znamená posun v číselné řadě nahoru.

"version" => $version intiger

Dokumentace

Request body

{
"token": "",
"version": "",
"signature": ""
}
                                        

Response body

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

Podpisový vzor:

<?php
$data = implode(";", [
    "token" => "...",
    ]);
$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á změna verze

• Doplněk nezmění verzi, 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 - změna verze by proběhla v pořádku, ale zákazník musí před změnou verze splnit dodatečné podmínky, než bude moct změnit verzi doplňku.
  • FALSE (bool) - Vše proběhlo v pořádku, doplněk je úspěšně převeden na novou verzi.