EasyCargo API útmutató (2. rész)

Amint azt már a cikk első részében említettük, ma inkább gyakorlati oldaláról mutatjuk be az EasyCargo API-t. Ehhez most az API kliensünket vesszük igénybe. Az API-t a  ReqBin online eszközzel is tesztelni fogjuk. Ez lehetővé teszi a kommunikációt egy WWW szerverrel, aminek köszönhetően letölthetjük a minket érdeklő adatokat az EasyCargo rakodástervező szoftverünkből.

A tesztelés egy dolog, ugyanakkor a valós életben előfordulhat, hogy Java plugin-t használ a szoftveréhez, vagy JavaScript funkciókat hív le az SAP-ból. Bővebben erről a módszerről, a Make platformról és az API használatára vonatkozó más gyakorlati példákról sorozatunk következő részében olvashat.

Tekintse meg, hogyan néz ki a fenti kérés a ReqBin-ben

A fenti képen az EasyCargo API kliensünk látható. Ahhoz, hogy tetszőleges API-kérelmet lehessen továbbítani a webszerverre, először engedélyeztetni kell a klienst. Tehát a futtatandó kérés a POST http://go.easycargo3d.com/api/v1/authentication felhasználónévvel és API-kulccsal. A válasz keretén belül egy hitelesítő tokent kapnak a szervertől. Minden további API-kérést (hacsak másképp nincs meghatározva) hitelesíteni kell a lekérdezett token fejléchez való hozzáadásával. Itt érdemes megjegyezni, hogy minden API-kérésre a token tulajdonosának nevében kerül sor. A kéréseket és válaszokat JSON vagy XML formátumban kell létrehozni.

Túl vagyunk a hitelesítésen, úgyhogy továbbléphetünk az érdekesebb API varázslatokhoz. Tegyük fel, hogy X felhasználó fiókjában a következő rakodások kerültek elmentésre:

Az API követelményeit éppen ezeken mutatjuk be, miután a rakodások valószínűleg az EasyCargo legfontosabb részei. Más követelmények is hasonlóan vannak megfogalmazva, mint például a felhasználó menedzsment, ezért úgy gondoljuk, hogy e cikk elolvasása után már könnyedén kezelheti a hasonló követelményeket. Az EasyCargo API dokumentációjában a programozási felület minden egyes módszerét ismertetjük és elmagyarázzuk. Ha bármilyen kérdése lenne, kérdezzen bátran.

Rakodással kapcsolatos API-követelmények

Az API dokumentációból kiolvashatjuk, hogy megfelelően megfogalmazott kérések segítségével megkaphatjuk a szervertől az összes rakodást tartalmazó listát, valamint az EasyCargo-ban egy adott fiók alatt lévő konkrét rakodásra vonatkozó adatokat. A fiókban akár létre is hozhatunk vagy eltávolíthatunk egy-egy rakodást.

Az összes rakodást tartalmazó lista lekérdezése

Tekintse meg, hogyan néz ki a fenti kérés a ReqBin-ben

Konkrét rakodásra vonatkozó információk lekérése

Tekintse meg, hogyan néz ki a fenti kérés a ReqBin-ben

Rakodás létrehozása

Tekintse meg, hogyan néz ki a fenti kérés a ReqBin-ben

Amint azt láthatja, a rakomány sikeresen létre lett hozva és elmentésre került az EasyCargo fiókjukba.

Ezután egyszerűen megnyithatja az újonnan létrehozott rakodást az alkalmazásban.

Rakodás törlése

Tekintse meg, hogyan néz ki a fenti kérés a ReqBin-ben

A rakodást a megfelelő kérés alapján eltávolítottuk a fiókjából.

Még néhány szó az API-ról

• Az API-kérelmek száma időben korlátozott (óránként 60 kérés). A kvóták szabályozására az időkeret eltolásával kerül sor, hogy egy adott időszakban csak meghatározott számú kérés legyen engedélyezve.
• Az API-hibák normál HTTP státuszkódokkal kerülnek visszaküldésre. A legtöbb esetben a válasz teste konkrét üzenetet tartalmaz arra vonatkozóan, hogy mi romlott el.
• Az API segítségével nem számítható ki a végső rakodási terv. Az EasyCargo rendszerbe való bejelentkezéshez és a Rakodás gomb megnyomásához mindig emberre van szükség.
• Az API-kliensnek támogatnia kell a hozzáférést, valamint a kérés és válasz fejléc módosítását, illetve a JSON- vagy XML formátumú adatok elemzését.
• Az így kapott rakodási terv kiszámításához az API-felhasználónak be kell jelentkeznie az EasyCargo rendszerbe.
• Egyes API-módszerek támogatják az opcionális paraméterek használatát, például „from”. A dokumentációból megismerheti ezek mindegyikének a jelentését. Mindezen paraméterek például az összes kért rakodás listájának lekérdezésére vehetők igénybe. Elég mindössze név=érték alakban hozzáadni a paramétereket a címhez a „?” mögé „&”-val elválasztva, pl: http://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.

Amint azt Ön is láthatta, az API igazán hasznos dolog. A mai cikk az EasyCargo API-ról szóló sorozat második része, így ha még nem olvasta az első részt, itt bepótolhatja. A harmadik részben megismerkedhet az API használatának előnyeivel, és bemutatunk néhány valós felhasználási esetet is.