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ázunkat összeintegrálhatjuk külső rendszerekkel, például készletkezelő rendszerrel. Így amennyiben korábban olyan rendszerrel szerettük volna összekötni webáruházunkat, 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 egy külső rendszerben módosítottunk árat, akkor emiatt a változtatás miatt át kellett írnunk a webáruházból kinyert XLSX fájlt, majd azt be kellett importálnunk 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 gondolnunk.

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énk kihasználni az API képességeit, úgy ennek konkrét beállítását sajnos nem tudjuk vállalni, saját fejlesztőre lesz szükség. Ám igyekszünk minden segítséget megadni az API használatához.

Az API használatához először is szükségünk lesz egy felhasználónévre és egy jelszóra. Ezek az adatok a bolt admin felületén a Beállítások > API beállítások 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.myshoprenter.hu/

Itt a "shopname" a webáruházunk neve lesz, amely nem az egyedi domain név, amit megadtunk, hanem az a név, melyet a webáruház létrehozásánál választottunk (azaz amelyet átirányítottunk a saját domain nevünkre - 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 egy adott megrendelés adatait szeretnénk lekérni, úgy például 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

• API hívásokkal kapcsolatos követelmények és korlátozások
• Lehetséges válaszkódok és hibaüzenetek
• A full paraméter
• API batch feldolgozó
• API Outer ID használata
• Kiterjesztett Resourceok (Extend Resource)

Amennyiben külső rendszerek összekötésével vagy egyedi rendszerek fejlesztésével kapcsolatban további segítségre lenne szükséged, keresd bizalommal külsős fejlesztésben jártas Shoprenter Szakértőinket.