Smazání

Jednoduchá odpověď pro odstranění aplikace z prodejního kanálu

Když je aplikace úspěšně nastavena, tak se u dané aplikace ukáže křížek, kterým lze aplikaci odstranit neboli smazat její nastavení. V tomto kroku, když používáte nějaký callback případně ui prvek, či snippety je potřeba je přes Retailys API odstranit. Také je potřeba smazat nastavení z databáze aplikace. Veškerá tato odstranění se řeší ve funkci, kterou jsme si v inicializaci aplikace uvedli jako routu pro odstranění aplikace tedy callback-remove.

Například použitím tohoto endpointu lze smazat statický snippet.

Endpoint /System/Layouts/Eshop/Layout/StaticSnippets/{id} na API můžete snadno vyzkoušet.

Na tuto routu obdržíme parametr token, který bude obsahovat náš token přiřazený k instanci, který máme uložený v databázi naší aplikace. Následně podle něho vyhledáme config a pokud nějaký existuje, tak ho můžeme smazat.

Pro úspěšné smazání je potřeba vrátit formát JSON, který bude obsahovat parametr status a ten bude mít hodnotu removed, aby aplikace byla považována za odstraněnou z naší instance.

Jednoduchý příklad, kdy se na konci funkce, kde se postaráme o odstranění nastavení aplikace z databáze, případně prvků přes API, stačí vrátit jednoduchý JSON.

return $this->json(
            [
                'status' => 'removed',
            ]
        );