Shippo csatlakozó

Integráció a Shippo API-jával

Bevezetés

AShippo egy több fuvarozót magában foglaló szállítási API és webes alkalmazás, amely olyan fuvarozókat tartalmaz, mint a USPS, a DHL, a FedEx és sok más. Az ügyfelek szállítási díjakat kaphatnak, címkéket nyomtathatnak, nemzetközi dokumentumokat automatizálhatnak, nyomon követhetik a küldeményeket és megkönnyíthetik a visszaküldést.

Cél

Ez az integráció kiemeli, hogyan lehet kihasználni a Tulip HTTP-csatlakozó funkcióit a Shippo API-jával való integrációhoz, hogy automatizáljuk a küldemények létrehozását, a különböző fuvarozóktól különböző díjakat kapjunk, kiválasszuk a legjobb árat és végül létrehozzuk és kinyomtassuk a küldeménycímkét, valamint a küldemények nyomon követésének lehetőségét. Mindezt a Tulip alkalmazásból végezheti el. A különböző felhasználási esetektől függően a Tulip integrációja kihasználható, hogy az ellátási lánc működése felett ellenőrzést gyakorolhassunk és valós idejű átláthatóságot biztosítsunk a csomagok kiszállítása során.

API dokumentum

Shippo API dokumentáció

Előfeltételek

Hozzon létre egy fiókot a Shippo weboldalán & generáljon API tokeneket, amelyeket engedélyezési fejlécként használnak a Shippo API-hoz intézett összes hívásnál. A Shippo lehetővé teszi egy teszt és egy élő token generálását. A teszt token felhasználható az API-val történő teszt HTTP hívásokhoz és a Tulip alkalmazás megtervezéséhez, amint az alkalmazás elkészült, a tokenek kicserélhetők és az alkalmazások telepíthetők a termelésben, hogy valós időben generáljanak szállítási címkéket, tranzakciókat.

Tulip kapcsolat részletei

A Tulip HTTP-konnektort a következő adatokkal kell konfigurálni a Shippóval való kapcsolat létrehozásához.

1. Futtatás: Felhőcsatlakozó host
2. Host : api.goshippo.com
3. Port:443
4. TLS:Igen
5. A Shippo tokenek, mint Authorization Header átadhatók a Connector Function-on keresztül.

Csatlakozó funkció

Küldemény létrehozása

Cél

1. Ez a csatlakozó funkció új küldeményt hoz létre a Shippo API POST hívásával, a feladó, a címzett és a csomag adatai a kérés testének részét képezik.
2. Sikeres létrehozás esetén a Shippo egy JSON objektumot küld vissza, amely tartalmazza a létrehozott küldemény állapotát, valamint a különböző szállítók díjszabásainak választékát, amelyet a felhasználók felhasználhatnak a tranzakció továbblépéséhez és kezdeményezéséhez. A felhasználók kiválaszthatják a megfelelő árfolyamot, az árfolyam-azonosítókat Tulip változókban tárolhatják, amelyeket dinamikusan átadnak a tranzakció létrehozásához, hogy a megfelelő csatlakozó funkcióban létrehozzák a küldemény címkéjét.

Végpont

1. HTTP POST hívás a végpontra: https://api.goshippo.com:443/shipments/

Engedélyezési fejléc

A Shippo API-val történő hitelesítéshez a Shippo HTTP-tokenjét át kell adni a kérés fejlécében. A következő formátum

Engedélyezés : ShippoToken ($ShippoToken$)

Kötelező bemenet

A következők a kérelem testében átadott bemeneti paraméterek, ahol a JSON a tartalom típusa.

1. Küldő neve, utca, város, állam, irányítószám, ország.
2. Címzettek neve, utca, város, állam, irányítószám, ország.
3. Csomag méretei - hosszúság, szélesség, szélesség és súly.

Szükséges kimeneti kivonatoló

A létrehozott küldeményobjektumról számos információ kerül visszaadásra, azonban a kivonandó fontos mezőket az alábbiakban említjük meg

1. Állapot: Jelzi, hogy a küldeményt sikeresen létrehozták-e
2. Szállítási azonosító: Hivatkozhat a létrehozott küldemény részleteinek lekérdezésére.
3. Díjszabási lehetőségek: A különböző szállítók által biztosított különböző díjszabási opciókat jelző objektumok tömbje. A Rate ID a fontos kulcs a többi közül, amelyet ki kell vonni, és amelyet át kell adni a tényleges tranzakció létrehozásához az adott szállítmányhoz.

Tranzakció létrehozása

Cél

1. Ez a csatlakozófüggvény létrehozza a tranzakciót, miután kiválasztotta a szállítót és a végső árfolyamot az előző csatlakozófüggvényben az új küldemény létrehozásakor visszaküldött különböző lehetőségek közül.
2. A sikeres tranzakció létrehozása a Shippo végpontjának POST HTTP-hívásával történik a választott árfolyamhoz tartozó azonosító átadásával. Sikeres hívás esetén a Shippo egy JSON objektumot küld vissza, amely többek között tartalmazza a tranzakció állapotát, a nyomon követési azonosítót, a szállítási címkét és a nyomon követési URL-t. A visszaküldött szállítási címke közvetlenül a Tulip alkalmazásból nyomtatható ki.

Végpont

1. HTTP POST hívás a végpontra: https://api.goshippo.com:443/transactions/.

Engedélyezési fejléc

A Shippo API-val való hitelesítéshez a Shippo HTTP-tokenjét kell átadni a kérés fejlécében. A következő formátum

Engedélyezés : ShippoToken ($ShippoToken$)

Kötelező bemenet

A következők a kérelem testében átadott bemeneti paraméterek, ahol a JSON a tartalom típusa.

1. Árfolyamazonosító: A sikeres tranzakció létrehozása érdekében a továbblépéshez kiválasztott árfolyam azonosítójának átadása.

Kötelező kimeneti kivonat

A létrehozott Szállítási objektumról rengeteg információ érkezik vissza, azonban a kivonandó fontos mezőket az alábbiakban említjük meg

1. Állapot: Jelzi, hogy a tranzakció sikeresen létrejött-e.
2. Tranzakció azonosítója: Hivatkozhat a végrehajtott tranzakció részleteinek lekérdezésére.
3. Nyomon követési szám: A küldemény nyomon követéséhez
4. Nyomonkövetési URL: A kiválasztott szállító nyomon követési oldalának URL címe.
5. Címke URL: Szállítási címke, amely beágyazható a Tulip alkalmazásba nyomtatás céljából.