Přidání doplňku do eshopu

Přídání doplňku do eshopu

Během procesu instalace je doplňku vytvořen API klíč a spolu s kódem eshopu je předán metodou POST na zadanou instalační URL.

Struktura JSON objektu:

 
    {
        "eshopCode": "...",
        "apiToken": "...", // X-Wa-api-token použitelný pro API Webareal
        "apiUrl": "api.webareal.cz",
        "language": "cs",
        "system": "webareal.cz",
        "tariffId": "id"
        "email": "email@email.com"
        "domain": "www.domain.tld"
    }

Tyto údaje mohou být uloženy do databáze a eshopCode může být použit pro identifikaci různých eshopů, na kterých je doplněk nainstalován. V tuto chvíli je možné provézt potřebné nastavení na API (např. registrace webhooku).

Pro úspěšné dokončení instalace musí doplněk odpovědět stavovým kódem 200 a v těle odpovědi musí být JSON objekt: 

 
    {
        "status": "DONE"
    }

Status může nabývat jedné z následujících hodnot:

  • DONE - nastavení bylo dokončeno
  • IN_PROGRESS - doplněk provádí nastavení na pozadí, které může trvat delší dobu
  • USER_SETUP_REQUIRED - vyžadováno nastavení uživatele eshopu

Pokud je odpovědí stav jiný než DONE, doplněk nemůže být na eshopu plně aktivován. Stav může být později změněn prostřednictvím API metody PUT /plugin 

 
    {
        "status": "DONE"
    }

Odstranění doplňku z eshopu

Doplněk může být informován o odstranění z eshopu prostřednictvím definované odinstalační URL, která je volána metodou POST s následujícími parametry:

 
    {
        "eshopCode": "...",
        "language": "cs",
        "system": "webareal.cz"
    }
Zpět