API dokumentáció
Az API célja, hogy lehetővé tegye az UnasShop webáruház egyszerű, akár kétirányú összekapcsolását külső (pl.: számlázó, készletkezelő, marketing, stb...) rendszerekkel. Lehetőség van adatok lekérdezésére, módosítására, új adatok rögzítésére illetve adatok törlésére. Az API kapcsolat kialakításához fejlesztői ismeretek szükségesek.

Az API kommunikáció HTTP alapú webszolgáltatásokon keresztül történik. Az API kapcsolat PREMIUM és VIP előfizetői csomaggal használható. Minden kérés XML formátumban küldhető át, illetve minden válasz is XML formában érkezik. Az API a https://api.unas.eu/shop/ címen érhető el, minden funkció POST metódussal használható. A hívás során a konkrét funkció elérési pontját az API URL után kell fűzni (pl.: https://api.unas.eu/shop/setProduct). Sikeres hívás esetén 200-as HTTP válaszkódot adunk vissza. Általános hiba esetén minden kérés egy XML-t ad vissza, amiben egyetlen Error node szerepel, a HTTP válaszkód ilyen esetben 400.

Az egyes funkciók részletes leírását alább találja:
Az áruház adminisztrációs felületén a Beállítások / Külső kapcsolatok / API kapcsolat menüben hozhat létre API kulcsot. Itt beállíthatja azt is, hogy az adott API kulcs segítségével milyen API funkciók legyenek elérhetők. Bármely API funkció használata előtt belépés szükséges. Ehhez a "login" API funkció használható, amihez az alábbi formátumú bemeneti XML tartozik:
Ezt a megoldást új API kliens fejlesztésekhez NEM javasoljuk, ilyen esetben kérjük használja az API kulcs alapú azonosítást. Az áruház adminisztrációs felületén a Beállítások / Külső kapcsolatok / API kapcsolat menüben engedélyezheti a felhasználónév alapú azonosítást. A használt felhasználó minden API funkcióhoz korlátozás nélkül hozzáférhet. Az adott API funkció használatához az autentikációs adatokat, illetve a funkció bemeneti adatait POST változóként kell elküldeni. Az autentikációs XML az alábbi módon épül fel:
Visszaadja a kérésében meghatározott feltételeknek megfelelő rendelés vagy rendelések adatait.
A kérésben egy XML-t adhat meg a getOrder funkciónál meghatározott kimenethez hasonló formátumában. Itt egy vagy akár több rendelés is szerepelhet. A funkció egy XML-lel tér vissza, amiben szerepelnek a rendelések egyedi azonosítói és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem.
Visszaadja a kérésben meghatározott feltételeknek megfelelő termékek raktárkészlet adatait. Ha nem ad meg konkrét cikkszámot vagy azonosítót, akkor csak a LimitStart és LimitNum paraméterekkel együtt használható és visszaadja azon termékek aktuális készletét, melyeknél van raktárkezelés.
A kérésben egy XML-t adhat meg a getStock funkciónál meghatározott kimenet formátumában. A funkció egy XML-lel tér vissza, amiben szerepelnek a termékek egyedi azonosítói, cikkszámai, és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem.
Visszaadja a kérésben meghatározott feltételeknek megfelelő termékek adatait. A válasz XML-ben (megfelelő feltételek esetén) szerepelnek a törölt termékek is, ezekről már csak a törlés tényét tároljuk (1 hónapig), egyéb adatot nem.
A kérésben egy XML-t adhat meg a getProduct funkciónál meghatározott kimenethez hasonló formátumban. A funkció egy XML-lel tér vissza, amiben szerepelnek a termékek egyedi azonosítói, cikkszámai, és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem. Áruházban már létező cikkszám esetén mindenképpen "modify", nem létező cikkszám esetén mindenképpen "add" műveletet hajtunk végre, kivétel a "delete" művelet.
A kérésben meghatározott formátumban generálódik egy teljes termék adatbázis. A termék adatbázis felépítése megegyezik az admin felületen a Termékek/Termék adatbázis menüben letölthető adatbázis felépítésével. A funkció egy XML-lel tér vissza, amiben szerepel a generált termék adatbázis URL-je, ezt 1 órán belül kell letölteni.
Az admin felületen a Termékek/Termék adatbázis menüben vagy a getProductDB funkcióval letöltött adatbázist lehet visszatölteni az áruházba, ennek segítségével a termékek szinte összes adata módosítható, illetve új termékek is rögzíthetők. A funkció egy XML-lel tér vissza, amiben az importtal kapcsolatos statisztikai adatok szerepelnek.
Visszaadja a kérésben meghatározott feltételeknek megfelelő kategóriák adatait.
A kérésben egy XML-t adhat meg a getCategory funkciónál meghatározott kimenethez hasonló formátumában. Itt egy vagy akár több kategória is szerepelhet. A funkció egy XML-lel tér vissza, amiben szerepelnek a kategóriák egyedi azonosítói és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem.
Visszaadja a kérésben meghatározott feltételeknek megfelelő vásárlók adatait.
A kérésben egy XML-t adhat meg a getCustomer funkciónál meghatározott kimenethez hasonló formátumában. Itt egy vagy akár több vásárló is szerepelhet. A funkció egy XML-lel tér vissza, amiben szerepelnek a vásárlók egyedi azonosítói és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem.
Visszaadja a kérésben meghatározott feltételeknek megfelelő hírlevél igénylők adatait.
A kérésben egy XML-t adhat meg a getNewsletter funkciónál meghatározott kimenet formátumában. A funkció egy XML-lel tér vissza, amiben szerepelnek az e-mail címek, és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem.
Visszaadja a kérésben meghatározott feltételeknek megfelelő SCRIPT-ek adatait.
A kérésben egy XML-t adhat meg a getScriptTag funkciónál meghatározott kimenethez hasonló formátumában. Itt egy vagy akár több SCRIPT is szerepelhet. A funkció egy XML-lel tér vissza, amiben szerepelnek a SCRIPTek egyedi azonosítói és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem.