Postman használata és Példakódok

API használathoz példák

Minta PHP fájlok amiket ide kattintva érhet el.

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

 

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

 

 

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

0 Megjegyzések

Cikk zárolt megjegyzésekkel szemben.