Bővítmény hozzáadása a webáruházhoz

Bővítmény hozzáadása a webáruházhoz

A telepítési folyamat során egy API-kulcsot hozunk létre a bővítményhez, amelyet az eshop azonosító kóddal együtt a POST adjunk át a megadott telepítési URL-címre.

A JSON objektum szerkezete:

 
    {
        "eshopCode": "...",
        "apiToken": "...", // X-Wa-api-token használható a Webareal API-hoz
        "apiUrl": "api.webareal.cz",
        "language": "cs",
        "system": "webareal.cz",
        "tariffId": "id"
        "email": "email@email.com"
        "domain": "www.domain.tld"
    }

Ezek az adatok adatbázisban tárolhatók, a eshopCode segítségével azonosítani lehet a különböző eshopokat, amelyekben a bővítmény telepítve van. Ezen a ponton elvégezhetők a szükséges API beállítások (pl. webhook regisztráció).

A sikeres telepítéshez a bővítménynek 200-as státuszkóddal kell válaszolnia, és a választestnek egy JSON objektumot kell tartalmaznia: 

 
    {
        "status": "DONE"
    }

A válasz a következő státuszokat veheti fel:

  • DONE - a telepítés befejeződött
  • IN_PROGRESS - a bővítmény háttérbeállításokat hajt végre, ami hosszú időt vehet igénybe.
  • USER_SETUP_REQUIRED - felhasználói beállításokra van szükség

Amennyiben a válasz státusza nem DONE, akkor a bővítmény nem aktiválható teljeskörűen a webshopban. A státusz később módosítható az APIn keresztül PUT /plugin 

 
    {
        "status": "DONE"
    }

Bővítmény eltávolítása a webshopból

A bővítményt a webshopból a megadott URL meghívásával lehet eltávolítani, amit a POST metódus hív meg a következő paraméterekkel:

 
    {
        "eshopCode": "...",
        "language": "cs",
        "system": "webareal.cz"
    }
Vissza