Pridanie doplnku do eshopu

Pridanie doplnku do eshopu

Počas procesu inštalácie je doplnku vytvorený API kľúč a spolu s kódom eshopu je odovzdaný metódou POST na zadanú inštalačnú URL.

Štruktúra JSON objektu:

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

Tieto údaje môžu byť uložené do databázy a eshopCode môže byť použitý na identifikáciu rôznych eshopov, na ktorých je doplnok nainštalovaný. V tejto chvíli je možné vykonať potrebné nastavenia na API (napr. registrácia webhooku).

Pre úspešné dokončenie inštalácie musí doplnok odpovedať stavovým kódom 200 av tele odpovede musí byť JSON objekt: 

 
    {
        "status": "DONE"
    }

Status môže nadobúdať jednu z nasledujúcich hodnôt:

  • DONE - nastavenie bolo dokončené
  • IN_PROGRESS - doplnok vykonáva nastavenia na pozadí, ktoré môže trvať dlhšiu dobu
  • USER_SETUP_REQUIRED - vyžadované nastavenie užívateľa eshopu

Ak je odpoveďou stav iný ako DONE, doplnok nemôže byť na eshope plne aktivovaný. Stav môže byť neskôr zmenený prostredníctvom API metódy PUT /plugin 

 
    {
        "status": "DONE"
    }

Odstránenie doplnku z eshopu

Doplnok môže byť informovaný o odstránení z eshopu prostredníctvom definovanej odinštalačnej URL, ktorá je volaná metódou POST s nasledujúcimi parametrami:

 
    {
        "eshopCode": "...",
        "language": "cs",
        "system": "webareal.cz"
    }
Späť