API dokumentáció

gomb.png

Bevezető

A ShopRenter API segítségével a ShopRenter rendszerében megoldható, hogy akár az egész webáruház tartalmát (így például a termékeket, kategóriákat, felhasználókat, szöveges tartalmakat, rendeléseket) külső rendszerből lehessen menedzselni. Mindezt automatizált módon, pár másodperc alatt.

Az API segít webáruházát összeintegrálni külső rendszerekkel, például készletkezelő rendszerrel. Így amennyiben Ön korábban olyan rendszerrel szerette volna összekötni webáruházát, melyhez nem készült külön integráció, az API hasznos megoldásként szolgálhat a továbbiakban.

Például ha Ön egy külső rendszerben módosított árat, akkor emiatt a változtatás miatt át kellett írnia a webáruházból kinyert XLS fájlt, majd azt beimportálnia a webáruházba az Export/import funkció segítségével. Az API segítségével viszont erre nincs szükség, hiszen a kétoldalú kommunikációnak köszönhetően a külső rendszerben történő változás pár másodpercen belül a webáruházban is megjelenik.

De ugyanígy mást is meg lehet változtatni. Az API-n keresztül ugyanis az alábbi 4 művelet hajtható végre:

  • az adatok lekérése,
  • módosítása,
  • új adat létrehozása,
  • adat törlése.

Ebből jól látható, hogy milyen lehetőségeket biztosít ez a funkció, hiszen elég csupán a termékek menedzselésére gondolnia.

Fontosnak tartjuk viszont leszögezni, hogy az API használatához fejlesztői ismeretek szükségesek, ugyanis nem mondható egyszerűnek egy laikus felhasználó számára. Tehát amennyiben szeretné kihasználni az API képességeit, úgy ennek konkrét beállítását sajnos nem tudjuk vállalni, Önnek saját fejlesztőre lesz szüksége. Ám igyekszünk minden segítséget megadni az API használatához.

Az API használatához először is szüksége lesz egy felhasználónévre és egy jelszóra. Ezek az adatok a bolt admin felületén Beállítások/Integrációk/ShopRenter API menüpont alatt érhetőek el. A beállítás Gold vagy annál nagyobb csomaggal rendelkező ügyfeleinknek érhető el.

Az API hívásokat pedig az alábbi URL-en lehet végrehajtani:

http://shopname.api.shoprenter.hu/

Itt a "shopname" az Ön webáruházának neve lesz, amely nem az egyedi domain név amit megadott, hanem az a név, melyet a webáruház létrehozásánál választott (azaz amelyet átirányított a saját domain nevére - a korábbi shoprenteres aldomain. Ez az információ is megtalálható pontosan az admin menüpontban.

Amit mindenképpen tudni kell az API-val kapcsolatban, hogy alapvetően 4 parancsot lehet vele végrehajtani, illetve azt, hogy a belső ID-kat hash kódokká átalakítva használjuk:

  • GET - Egy konkrét elem lekérésére szolgál.

    Például a rendelések lekéréshez az alábbi URL-t adjuk meg: /orders?page=0&limit=5
    Ha mondjuk egy adott megrendelés adatait szeretnénk lekérni, úgy mondjuk az alábbi URL-t kell meghívni:   /orders/b3JkZXItb3JkZXJfaWQ9Mw==

    Itt jól látható, hogy nem az admin felületen is látható ID szerepel, hanem annak egy átalakított változata.
  • POST -  Létrehozásra és módosításra is szolgál.
  • PUT - Létrehozásra és módosításra is szolgál.

    A POST és a PUT közötti legfőbb különbség, hogy az előbbi használatával módosítható például egy termék egyetlen paramétere (például ár) anélkül, hogy minden más változna. Ezzel szemben ha PUT paranccsal szeretnénk árat módosítani, úgy egy árváltoztatás esetén a termék minden egyéb paramétere NULL értéket kap majd.
  • DELETE - Törlésre szolgál.

Fontos még megjegyeznünk, hogy multipart/form-data-t fogadunk el content-type típusként a küldés során.

Tartalomjegyzék

 

Van még kérdése? Kérelem beküldése

0 Megjegyzések

Cikk zárolt megjegyzésekkel szemben.