API használathoz példák

A PHP teszteléshez használható API klienst ide kattintva érhetjük el.

Shoprenter API példa kollekciók (használatukról bővebben is lesz szó a cikkben): Letöltés

POSTMAN használata

A Postman használatáról részletesebben olvashatunk az alábbi linken.

A Postman egy komplett eszköztár API fejlesztők részére. A programmal gyorsan és hatékonyan lehet dolgozni az API-val, mivel támogatja a fejlesztők minden munkafolyamatát, továbbá elérhető Mac OS X, Windows, Linux és Chrome felhasználók számára is.

Telepítés

1. Az app oldalon válasszuk ki, milyen rendszert használunk, majd kattintsunk a letöltés gombra.

macOS telepítés

Amint sikerült a letöltés, a file-t húzzuk be az “Applications” mappába. Dupla kattintással meg tudjuk nyitni az applikációt.

Windows telepítés

Töltsük le a setup file-t, majd futtassuk a telepítőt.

Linux telepítés

A Linuxon történő telepítés eltérő lehet. A következő útmutatóban bővebb információ található erről: Postman app on Ubuntu 16.04.

2. Chrome böngésző esetén lehetőség van bővítményként hozzáadni a böngészőhöz a Postmant.

Használat

A Postman elindítása után nincs más dolgunk, mint elküldeni az első kérést vagy létrehozni a saját kollekciónkat. Amennyiben további információ szükséges az induláshoz, az itt lévő dokumentációban ezekre rá tudunk keresni.

Példa kollekció importálása

Shoprenter részről előre elkészítettünk egy kollekciót, amit be lehet importálni és használni. Ez a JSON file ezen az URL-en érhető el: https://www.shoprenter.hu/api/postman/ShoprenterAPI.postman_collection.json

A Postmanen belül a bal felső sarokban találunk egy import gombot, ezzel be tudjuk importálni URL-ből vagy akár fájlból is a fenti példát:

Az import után a bal oldalon láthatjuk is, hogy kaptunk 5db POST példát.

Ezen az oldalon szükségünk lesz a Shoprenteres API belépési adatokra, amelyeket a bolt admin felületén a Beállítások > API beállítások menüben fogunk megtalálni.

A következő képen egy sikeres POST-ot láthatunk, amellyel egy új termék jött létre a bolton belül. Sikeres GET kérés esetén a standard 200-as válaszkódot kapjuk, jelen esetben azonban POST-olás történt, ezért 201-es válaszüzenetet kaptunk. Ha a státusz fülé visszük az egeret, akkor bővebb információt kaphatunk a kapott válaszkódról.

A kollekcióban lévő Batch szerkezetet mindenképpen ajánlani tudjuk tanulmányozásra, ezzel ugyanis tudjuk csökkenteni az elküldött kérések számát, így az API kapcsolatunk is optimalizált lesz.

Válasz átváltása JSON formátumra

A fenti példánál maradva lehetőség van JSON formátumban is megkapni a választ. Ehhez a headers fülön szükséges aktiválni az application/json key-t.

További példák

I. Akciós ár műveletek

A példáról részletesebben olvashatunk az alábbi linken.

Akciós ár felvétele

Az akciós ár API-n történő felvételéhez két dologra lesz szükségünk:

a termék resource azonosítójára, amelyhez az akciót akarjuk hozzáadni,
a vásárlói csoport resource azonosítójára, akiknek szól majd az akció.

Ezt követően az alábbiakat kell beállítanunk a Postmanben:

method: POST
url: http://boltneve.api.myshoprenter.hu/productSpecials
params: üres
body: form-data

data[priority]:1
data[price]:1000.0000
data[dateFrom]:2013-06-14
data[dateTo]:2013-06-29
data[minQuantity]:0
data[maxQuantity]:100
data[product][id]:product_resource_id
data[customerGroup][id]:customer_group_resource_id

Speciális eset, hogyha az a cél, hogy a "Mindenki" vevőcsoporthoz legyen kötve az akció. Ebben az esetben a data[customerGroup][id] sort töröljük ki teljesen vagy pipáljuk ki.

Akciós ár módosítása

Az akciós ár módosításához szükségünk lesz a korábban felvitt akciós ár resource azonosítójára, illetve az alábbiakat kell beállítanunk a Postmanben:

method: PUT
url: http://boltneve.api.myshoprenter.hu/productSpecials/product_special_id
params: üres
body: form-data

Amennyiben a vevőcsoportot szeretnénk módosítani a "Mindenki" vevőcsoportra, úgy érdemes törölni előbb az akciót és egy újat létrehozni. Minden más vevőcsoport esetén a módosítás végrehajtható.

Akciós ár törlése

Az akciós ár törléséhez szükségünk lesz a korábban felvitt akciós ár resource azonosítójára, illetve az alábbiakat kell beállítanunk a Postmanben:

method: DELETE
url: http://boltneve.api.myshoprenter.hu/productSpecials/product_special_id

Nap terméke hozzáadása (Megjelenés > Modulok)

A példáról részletesebben olvashatunk az alábbi linken.

A nap terméke modul leírását ebben a bejegyzésben találjuk meg.

A Nap terméke egy speciális akciós árnak számít, ahol megadhatjuk, hogy a hét egy adott napján melyik termék legyen kiemelve, aminek akciós ára van. Ennek megadása hasonlóan működik az akciós ár hozzáadásához.

method: POST
url: http://boltneve.api.myshoprenter.hu/productSpecials
params: üres
body: form-data

data[priority]:-1
data[price]:1000.0000
data[product][id]:product_resource_id
data[customerGroup][id]:customer_group_resource_id
data[type]: day_spec
data[dayOfWeek]: [1-7]

A fontosabb különbségek:

a priority értéke -1,
kiegészül egy type mezővel, amelynek day_spec-nek kell lennie,
kiegészül egy dayOfWeek mezővel, amelynek 1-7 közötti egész számnak kell lennie. A hét napjai az alábbiak 1: Hétfő, 2: Kedd, 3: Szerda, stb.),
nem kell megadni a dateFrom mezőt,
nem kell megadni a dateTo mezőt,
nem kell megadni a minQuantity mezőt,
nem kell megadni a maxQuantity mezőt.

Nap terméke módosítása

A nap terméke módosításához szükségünk lesz a korábban felvitt nap terméke/akciós ár resource azonosítójára, illetve az alábbiakat kell beállítanunk a Postmanben:

method: PUT
url: http://boltneve.api.myshoprenter.hu/productSpecials/
params: üres
body: form-data

data[priority]:-1
data[price]:1000.0000
data[product][id]:product_resource_id
data[customerGroup][id]:customer_group_resource_id
data[type]: day_spec
data[dayOfWeek]: [1-7].

II. Csatolt dokumentum feltöltése, társítása termékhez

Ha API-n keresztül szeretnénk csatolt dokumentumot feltölteni és termékhez társítani, a következőképpen járjunk el:

https://doc.shoprenter.hu/development/api-examples/02_attach_document_to_product.html

Postman használata és példakódok