Postman használata és Példakódok

API használathoz példák

PHP teszteléshez használható API klienst ide kattintva érheti el.

Shoprenter API példa kollekciók. (Használatáról bővebben a cikkben) Letöltés

További példák

  

POSTMAN használata

 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.

59161734.png

macOS telepítés

Amint sikerült a letöltés a file-t húzzuk be a “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.
  • 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 Postman-t.

 

Használat

 A Postman indítás 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. A kérdéses JSON file ezen az URL-en érhető el: https://www.shoprenter.hu/api/postman/ShoprenterAPI.postman_collection.json

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

collection_import.png

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

Postman_POST.png

 

Ezen az oldalon szükségünk lesz a ShopRenteres API belépési adatokra, ezeket a bolt admin felületén, a Beállítások > Integrációk > API beállítások menüben fogjuk megtalálni.

A következő képen egy sikeres POST-ot láthatunk, amivel egy új terméket jött létre a bolton belül. Sikeres GET kérés esetén a standard 200-as válaszkódok kapjuk, jelen esetben 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.

Sikeres_postol_s.png

 

 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 a application/json key-t. 

2018-01-24_11_41_27-.png

 

További példák

1. Akciós ár műveletek

a) 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ó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.shoprenter.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.

b) 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.shoprenter.hu/productSpecials/product_special_id
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

Amennyiben a vevőcsoportot szeretnéd módosítani "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ó.

c) 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.shoprenter.hu/productSpecials/product_special_id

d) Nap terméke hozzáadása (Beállítások->Megjelenés->Modul beállítása)

A nap terméke modul leírása: https://support.shoprenter.hu/hc/hu/articles/215106328-Aj%C3%A1nl%C3%B3-modulok#nap_termeke

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.shoprenter.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, aminek day_spec-nek kell lenni
  • kiegészül egy dayOfWeek mezővel, aminek 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

e) 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.shoprenter.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].

 

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

0 Megjegyzések

Cikk zárolt megjegyzésekkel szemben.