Adăugarea unui plugin în magazin

Adăugarea unui plugin în magazin

În timpul procesului de instalare, se creează o cheie API pentru plugin și împreună cu codul magazinului este transmisă prin metoda POST la URL-ul de instalare specificat.

Structura obiectului JSON:

 
    {
        "eshopCode": "...",
        "apiToken": "...", // X-Wa-api-token utilizabil pentru API-ul Eshop Rapid
        "apiUrl": "api.webareal.cz",
        "language": "cs",
        "system": "webareal.cz",
        "tariffId": "id"
        "email": "email@email.com"
        "domain": "www.domain.tld"
    }

Aceste date pot fi stocate într-o bază de date, iar eshopCode poate fi folosit pentru identificarea diferitelor magazine pe care plugin-ul este instalat. Momentan este posibilă efectuarea setărilor necesare pe API (de exemplu, înregistrarea webhook-ului).

Pentru a finaliza instalarea cu succes, plugin-ul trebuie să răspundă cu un cod de stare 200, iar corpul răspunsului trebuie să conțină un obiect JSON: 

 
    {
        "status": "DONE"
    }

Starea poate avea una dintre următoarele valori:

  • DONE - configurarea a fost finalizată
  • IN_PROGRESS - plugin-ul efectuează setări în fundal, ceea ce poate dura mult timp
  • USER_SETUP_REQUIRED - sunt necesare setări ale utilizatorului magazinului

Dacă starea de răspuns este diferită de DONE, plugin-ul nu poate fi activat complet în magazin. Starea poate fi modificată ulterior prin intermediul metodei API PUT /plugin 

 
    {
        "status": "DONE"
    }

Eliminarea unui plugin din magazin

Plugin-ul poate fi informat despre eliminarea sa din magazin printr-un URL de dezinstalare definit, care este apelat prin metoda POST cu următoarele parametri:

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