EasyCargo API útmutató (3. rész)
Üdvözöli az EasyCargo API minisorozatának legújabb része! Ma a tényleges rakodástervezési folyamatba merülünk lépésről lépésre bele. Megmutatjuk, hogyan egyszerűsíti le az API a logisztikai műveleteket – a felhasználói fiók létrehozásától a költségterületek meghatározásán át a nyomtatott reportok létrehozásáig. Ha tehát tudni szeretné, hogyan optimalizálhatja folyamatait az EasyCargo API használatával, akkor jó helyen jár!
Mielőtt belevágnánk, javasoljuk, hogy olvassa el sorozatunk előző részeit:
- Elméleti API útmutató – az összes alapvető információ és fogalom, amelyet ismernie kellene
- Gyakorlati API-követelmény és tesztelési útmutató – hogyan állíthatja be az API klienst és tesztelheti a végpontokat ReqBin segítségével?
Ha ezek az alapok már megvannak, máris folytathatjuk!
Rakodástervezés lépésről lépésre
A következő API kérelmek használatához hozzá kell adnia egy hitelesítési tokent a kérelem fejlécéhez. A részletes hitelesítési eljárásokat korábbi cikkünkben találja. A hitelesítési token megszerzéséhez rendelkeznie kell egy a felhasználói fiókjához kapcsolódó API-kulccsal. Lépjen kapcsolatba ügyfélszolgálatunkkal, amely kigenerálja számára a kulcsot. Felhívjuk figyelmét, hogy a hitelesítési tokenek csak 1,5 óráig érvényesek. Ez idő elteltével lejárnak, és többé nem működnek.
Felhasználói hozzáférési beállítások
Rakodástervezési folyamatunk első és egyik legfontosabb lépése a fiók létrehozása, például a raktári személyzet számára. Az /api/v1/users végpont segítségével új felhasználót hozhat létre konkrétan meghatározott jogosultságokkal. Amint azt az alábbi API-kérelemben látni fogja, meg kell adnia néhány információt az új felhasználóról. Ha ezt helyesen teszi meg, az új felhasználó azonnal megjelenik az EasyCargban a Felhasználók fül alatt.
Az alábbi kódban egy /api/v1/users végpontra irányuló kérelem látható, amelynek teste tartalmazza annak a felhasználónak az adatait, aki számára szeretné a fiókot létrehozni. Meg kell adnia az utónevét, vezetéknevét, bejelentkezési e-mail címét és a felhasználó típusát. A felhasználó típusa lehet adminisztrátor (a kérelem testében az 1-es szám jelzi) vagy standard felhasználó (2-es szám jelzi).
Lásd a teljes API-kérelem sablonját: https://reqbin.com/duacb1ye
Rakterek meghatározása
Mielőtt elkezdené a betöltést, meg kell határoznia, hogy hova kíván rakodni. Az /api/v1/cargospaces végpont lehetővé teszi különböző típusú konténerek definiálását. Minden egyes raktérnek tartalmaznia kell a hosszúságot, szélességet, magasságot és a maximális terhelhetőséget. Egyelőre csak konténereket támogatunk, ugyanakkor már dolgozunk más lehetőségeken is! A meghatározást követően a konténer megjelenik az EasyCargo felületén, visszaigazolva ezáltal, hogy Ön helyesen adta meg az alapadatokat. Az így létrehozott konténert azonnal felhasználhatja a rakodás megtervezéséhez.
Az alábbi kódban látható egy /api/v1/cargospaces végpont kérelem, amelynek teste tartalmazza a létrehozni kívánt konténer adatait. Adja meg a nevet, a szélességet, a magasságot, a hosszúságot és a maximális súlyt. Ezután válassza ki a mértékrendszert (1 a metrikus és 2 a birodalmi rendszer), valamint a raktér típusát. Az érték alapértelmezett esetben 1-re van állítva, ami konténert jelent.
Lásd a teljes API-kérelem sablonját: https://reqbin.com/8ieqp8ey
Rakodási tételek kezelése
Miután meghatározta a raktereket, ideje hozzáadni az egyes tételeket. Az /api/v1/shipment-inputs végpont segítségével megadhatja az egyes tételek méreteit, súlyát és megkötéseit. Az EasyCargo felület ezután az összes betöltött tétel és azok specifikációinak megjelenítésével vizuálisan megerősíti a sikeres rakodás létrehozását.
Az alábbi kódban egy új, 82 darab azonos típusú tételt tartalmazó küldeményt hozunk létre a
/api/v1/shipment-inputs végpont használatával. Adja meg a kérelem testében a rakomány nevét, a mértékegység rendszert és a tételeket. Megadhatja a tételek méreteit és korlátait is. Ebben a példában a Berlin nevű prioritási csoportban hozunk létre elemeket, mivel éppen oda szeretnénk hűtőszekrényeket szállítani. Lehetővé tesszük ezek tetszőleges forgatását és egymásra helyezését. A teljesség kedvéért még megemlítjük, hogy jelenleg sajnos nem lehetséges az API-n keresztül megváltoztatni az elemek színét sem azt, hogy megjelenjen-e az elem neve a dobozokon vagy ne.
Lásd a teljes API-kérelem sablonját: https://reqbin.com/ozixloob
Optimális rakodási terv generálása
Amint megvan az összes rakodási részlet, továbbléphetünk a tényleges költségterv generálásához. Az EasyCargo rendszer automatikusan kiszámítja a rakomány leghatékonyabb elhelyezését, figyelembe véve az egyenletes terhelést, a rakodási sorrendet és a kézbesítési követelményeket. Bár az API még nem tudja maga elvégezni az optimalizálást, elég az EasyCargo rendszerben a Rakodás gombra kattintatni, és a rendszer elvégzi Ön helyett a számításokat! Az első optimalizálást követően Önnek lehetősége van a rakodás manuális módosítására. A végleges terv így minden egyedi igényt képes kielégíteni.
Nyomtatott rakodási terv reportok
A rakodást befejezését követően Ön létrehozhat egy részletes reportot a rakomány elosztásáról és 3D-ben is megjelenítheti azt. Az /api/v1/shipment-reports/{id} végpont a kollégákkal és partnerekkel egyszerűen megosztható PDF formátumú report létrehozását kínálja. Tekintse meg, hogyan néz ki a rakodási report!
Az alábbi kódban láthatja, hogyan kaphatja meg a rakodás összes részletét a /api/v1/shipment-report/{id} végpont használatával. Első lépésben egy az /api/v1/shipments címre elküldött GET-kérelemmel meg kell szereznie a report ID azonosítóját. Ezt az azonosítót kivesszük a válaszból, és beépítjük a következő kérés URL-jébe (/api/v1/shipment-report/{id}). A válasz az alábbi képen látható összes részletet egy nyomtatható PDF-ben tartalmazza.
Lásd a teljes API-kérelem sablonját: https://reqbin.com/ust8mrq2
Megosztás és együttműködés
Szeretné megosztani a rakodási tervét a csapatával vagy partnereivel? A /api/v1/shipments végponton keresztül az összes rakodási információ elérhető, beleértve az interaktív 3D-s nézetet is. Nyissa ki a nyilvános rakodási linket az EasyCargo-ban és tekintse meg az egyes tételek így kapott helyét.
Az alábbi kódban az /api/v1/shipments/{id} végpont segítségével lekérdezzük a korábban létrehozott rakodásunk összes részletét. A küldemény ID azonosítójának lekérdezéséhez először küldjön egy GET-kérelmet az /api/v1/shipments címre. Miután azonosította a rakodás ID azonosítóját, küldjön egy GET-kérelmet az /api/v1/shipments/{id} címre, hogy megkapja a rakodás összes részletét, beleértve a nyilvános linket, a nyomtatható report linkjét és az alább felsorolt egyéb információkat.
Lásd az API-kérelem teljes sablonját: https://reqbin.com/y5p3zysj
Az EasyCargo API jó példa arra, hogy a jól megtervezett interfészek hogyan gyorsíthatják fel az összetett logisztikai műveleteket. Automatizálás és intelligens algoritmusok révén lehetővé teszi a rakodás hatékony megtervezését és kezelését. Az egyszerű integrációnak köszönhetően az API segítségével optimalizálhatja logisztikai folyamatait, és a könnyebb tervezés érdekében jól áttekinthető reportokat kaphat. Akár új az API-k terén, akár tapasztalt fejlesztő, az integrációs lehetőségek széleskörűek. Személyes konzultációért az EasyCargo bevezetéséről cégükben vegye fel velünk a kapcsolatot. Minden projekthez megtaláljuk a legjobb megoldást.