Webhook fejlesztői útmutató
Bevezetés
A FedEx Tracking Webhookjai közel valós idejű küldeményfrissítéseket biztosítanak a küldemény teljes életciklusa során.
A nyomonkövetési API-kkal ellentétben, amelyeknél az alkalmazásoknak kell lekérniük a küldemény állapotát, a webhookok automatikusan továbbítják a küldemény állapotával kapcsolatos frissítéseket, amint új információ válik elérhetővé.
Ez az útmutató a következőket tárgyalja:
- Három integrációs alapelv
- Hogyan működnek a webhookok
- Webhook-adattartalmak feldolgozása
- Ügyfélértesítések
- Időbélyegzők
- Bevált gyakorlatok és gyakori integrációs problémák
Három integrációs alapelv
A sikeres webhook-integrációk három alapelvet követnek.
Kezeljen minden webhook-adattartalmat a küldeményállapot frissítéseként
Ne feltételezze, hogy minden adattartalom új nyomonkövetési mérföldkövet jelent. A FedEx új adattartalmat tesz közzé, amikor új küldeményadat válik elérhetővé.
Az adattartalom a következőket tartalmazhatja:
- Új nyomonkövetési esemény
- Frissített kézbesítési előrejelzések
- Kézbesítési igazolás adatai
- Feldolgozta (felhasználói becenév)
- Egyéb küldeményadatokkal kapcsolatos változások
Több adattartalom is tartalmazhat különböző küldeményadatokat, miközben ugyanaz a nyomonkövetési mérföldkő tartozik hozzájuk.
Küldeményadatok tárolása és egyesítése
Minden adattartalom új vagy frissített küldeményinformációkat tartalmazhat. Tárolja az egyes webhook-adattartalmakat, és egyesítse az új információkat a meglévő küldeményrekordba.
Ne írja felül a meglévő küldeményrekordot a legújabb adattartalommal. Ehelyett őrizze meg a korábban beérkezett küldeményadatokat, és építse be az új információkat, hogy a küldemény teljes életciklusa során teljes és naprakész küldeményrekordot tartson fenn.
Használja az üzleti szabályokat a műveletek irányítására
Használja az üzleti szabályokat annak meghatározására, hogy mikor frissítse a rendszereket, illetve értesítse az ügyfeleket.
Ne indítson el műveleteket kizárólag egy eseménykód alapján. Mielőtt frissítené az ügyfeleknek szóló alkalmazásokat vagy értesítéseket küldene, értékelje a következőket:
- Nyomonkövetési mérföldkövek
- Küldemény elérhetősége
- Értesítés időzítése
- Üzleti követelmények
Javasolt feldolgozási modell
A következő ábra azt szemlélteti, hogyan működik együtt a webhook-integráció három alapelve egy tipikus megvalósításban. Minden webhook-adattartalmat a küldeményállapot frissítéseként dolgoznak fel, egy központi küldeményrekordba egyesítenek, majd üzleti szabályok alapján értékelnek ki, mielőtt frissítenék az alkalmazásokat vagy értesítéseket küldenének az ügyfeleknek.
Hogyan működnek a webhookok
A FedEx minden alkalommal új webhook-adattartalmat tesz közzé, amikor a küldemény adatai megváltoznak, vagy elérhetővé válnak. Egy küldemény az életciklusa során több adattartalmat is generálhat, beleértve az ugyanazon nyomonkövetési mérföldkőhöz kapcsolódó több adattartalmat is.
További adattartalmak lehetnek:
- Nyomonkövetési mérföldkövek: átvéve, fuvarozás alatt, kézbesítés alatt és kézbesítve.
- Küldeményadatok: Kézbesítési igazolás (PPOD), Aláírt kézbesítési igazolás (SPOD), GPS kézbesítési igazolás (GPS POD) és a címzett adatai.
- Kézbesítési előrejelzés frissítései: a kézbesítés becsült dátumának és időpontjának változásai.
- Rendkívüli események a kézbesítés során: Küldeményekkel kapcsolatos frissítések, valamint a kézbesítés során felmerülő rendkívüli események és azok okai.
- Küldemény-metaadatokkal kapcsolatos frissítések: Címfrissítések, hivatkozások és szolgáltatási adatok.
- Működési korrekciók: További nyomonkövetési mérföldkövek és a
previousEventsfrissítései.
Megjegyzés: A fényképes igazolás nem minden kézbesített küldemény esetében érhető el. Az elérhetőség a kézbesítés típusától, az aláírási követelményektől és egyéb üzleti szabályoktól függ.
Minden adattartalom a küldemény legutóbb ismert állapotát jeleníti meg. Dolgozzon fel minden adattartalmat, hogy a küldeményrekordja teljes és naprakész maradjon.
A webhook-frissítések megértése
Az alábbi példa bemutatja, hogyan generálható több webhook-adattartalom ugyanahhoz a küldeményhez annak teljes életciklusa során. Egyes adattartalmak új nyomonkövetési mérföldkövet vezetnek be. Mások olyan küldeményadatokat adnak hozzá, mint a kézbesítési előrejelzések, a kézbesítési igazolás adatai vagy a küldemény részletei.
Fontos: Több webhook-adattartalom is létrehozható ugyanahhoz a nyomonkövetési mérföldkőhöz. Dolgozzon fel minden adattartalmat, hogy az új küldeményadatok bekerüljenek a küldeményrekordba.
Webhook-adattartalmak feldolgozása
Minden webhook-adattartalmat a küldeményállapot frissítéseként dolgozzon fel.
Ne feltételezze, hogy minden webhook-adattartalom új nyomonkövetési mérföldkövet jelent. A FedEx új adattartalmat küld, amikor új küldeményadat válik elérhetővé. Például egy kézbesített küldeményhez további adattartalmak generálódhatnak, amikor a kézbesítési igazolásra vonatkozó információkat, a címzett adatait vagy más küldeményadatokat adnak hozzá vagy frissítenek.
Minden adattartalom esetében tegye fel a kérdést:
- Melyik nyomonkövetési mérföldkő változott?
- Milyen küldeményadatok változtak?
- Érinti-e a frissítés az ügyfeleknek szóló alkalmazást?
- Kivált-e értesítést a frissítés?
Dolgozza fel a küldemény előzményeit
Figyelje mind a scanEvent, mind a previousEvents értékét.
- A
scanEventaz adattartalomhoz kapcsolódó aktuális nyomonkövetési mérföldkövet tartalmazza. - A
previousEventstovábbi küldeményelőzményeket tartalmaz, beleértve azokat a mérföldköveket is, amelyek nem feltétlenül jelennek meg az aktuálisscanEventértékben.
Egyes nyomonkövetési mérföldkövek a previousEvents értékben jelennek meg, nem pedig új scanEvent értékként kerülnek közzétételre. Azok az alkalmazások, amelyek csak a scanEvent értéket dolgozzák fel, lemaradhatnak a küldeményfrissítésekről, és hiányos küldeményelőzményeket hozhatnak létre. Dolgozza fel mindkét gyűjteményt, hogy teljes képet kapjon a küldeményről.
Tartsa karban a küldeményrekordot
Tárolja az egyes webhook-adattartalmakat, és egyesítse az új információkat a meglévő küldeményrekordba.
A teljes küldeményrekord közel valós idejű rálátást biztosít a következőkre:
- Irányítópultok a küldemények nyomon követéséhez
- Ügyfélszolgálati alkalmazások
- Rendeléskezelési rendszerek (OMS)
Minden egyes adattartalommal frissítse a küldeményrekordot, hogy a küldeményről a lehető legpontosabb és legteljesebb képet tartsa fenn.
Ügyfélértesítések
Válasszon értesítési stratégiát az üzleti követelményei és a küldeményről megadni kívánt adatok részletessége alapján.
A FedEx Tracking Webhookjai közel valós időben küldenek frissítéseket a nyomonkövetési mérföldkövekről és a küldeményadatok változásairól. Használja az üzleti szabályokat annak meghatározására, hogy mely frissítések relevánsak az Ön vállalkozása számára, és melyek hagyhatók figyelmen kívül.
A gyakori értesítési stratégiák közé tartoznak a következők:
Közel valós idejű értesítések
Küldjön értesítéseket közvetlenül azután, hogy bekövetkezik egy nyomonkövetési mérföldkő.
Előnyök
- A lehető leggyorsabb kommunikáció az ügyfelekkel
- A lehető legalacsonyabb késleltetés
Megjegyzés: További küldeményadatok még nem feltétlenül állnak rendelkezésre.
Bővített értesítések
A nyomonkövetési mérföldkő után várjon néhány percet, hogy beérkezhessenek a további küldeményadatok.
Például a kézbesítési mérföldkő után várjon néhány percet, hogy begyűjthesse a következőket:
- Kézbesítési igazolás (POD)
- Aláírt kézbesítési igazolás (SPOD)
- GPS kézbesítési igazolás
- Feldolgozta (felhasználói becenév)
Előnyök
- Teljesebb körű küldeményfrissítések az ügyfelek számára
- Kevesebb utólagos értesítés
- Kevesebb ügyfélszolgálati megkeresés
A FedEx azt javasolja, hogy a kézbesítési mérföldkő után várjon körülbelül öt percet, mivel a kézbesítési igazolásra vonatkozó információkat gyakran röviddel az első kézbesítési esemény után adják hozzá.
Javaslatok az értesítések időzítéséhez
Az értesítések időzítése ügyfelenként és felhasználási esetenként változik. Az alábbi ajánlásokat azonban gyakran alkalmazzák a vásárlás utáni címzettértesítéseknél. Más értesítéstípusoknál (üzleti felhasználók, ügyfélszolgálati munkatársak stb.) válasszon az adott felhasználási esethez illő értesítési stratégiát.
- Becsült kézbesítés: Várjon körülbelül 15 percet, miután a vállalt kézbesítési dátum és az első kézbesítés becsült dátuma (EDD) is elérhetővé vált.
- Kézbesítés alatt: Küldje el azonnal, vagy az üzleti ütemtervének megfelelően (például naponta 8:00-kor).
- Kézbesítve: Várjon körülbelül 5 percet, hogy megérkezzenek a kézbesítési kiegészítő adatok.
- Kézbesítési kísérlet: Alkalmazza ugyanazt a megközelítést, mint a Kézbesítve értesítés esetében, hogy megérkezzenek a kézbesítési adatok.
Üzleti adatokra épülő értesítési szabályok kialakítása
Nem minden küldeményfrissítés igényel értesítést. Határozzon meg az üzleti követelményeit támogató értesítési szabályokat.
Javasolt megközelítés
Ne indítson értesítéseket kizárólag az eventCode érték alapján.
Értékelje a következőket:
- Nyomonkövetési mérföldkő
- Kötelező küldeményadatok
- Üzleti szabályok
Csak akkor hozzon létre értesítéseket, ha a szükséges információk rendelkezésre állnak.
Ez a megközelítés segít megelőzni a következőket:
- Duplikált értesítések
- Hiányzó kézbesítési adatok
- Hiányos kézbesítési értesítések
- Szükségtelen utólagos értesítések
Időbélyegzők
A felhasználási esetnek megfelelő időbélyeget használja.
eventCreateTime: amikor a küldemény eseménye történt. Az ügyfeleknek szóló nyomonkövetési előzményekhez használja.- Üzenetküldés időpontja: Amikor a FedEx elküldte a webhook-adattartalmat. Csak hibakeresésre és monitorozásra használja, ne az ügyfeleknek szóló felhasználói élmények esetén.
Az eventCreateTime azt jelzi, hogy mikor történt a küldeményesemény. A FedEx később hozzáadott további küldeményadatok esetén nem frissíti ezt az értéket. Például egy kézbesített esemény megőrzi az eredeti eventCreateTime értéket akkor is, ha a későbbi adattartalmakban kézbesítési igazolásra vonatkozó információkat vagy más küldeményfrissítéseket adnak hozzá. Ennek eredményeként az eventCreateTime értéket annak megállapítására kell használni, hogy mikor történt az esemény, nem pedig arra, hogy mikor adták hozzá a kapcsolódó küldeményadatokat.
Bizonyos esetekben előfordulhat, hogy az esemény időpontja nem áll rendelkezésre. Ilyen esetben az időbélyeg alapértelmezett 00:00:00 értéket tartalmazhat. A további adattartalmak pontosabb időbélyeget is tartalmazhatnak, amint az elérhetővé válik.
Bevált gyakorlatok és gyakori integrációs problémák
Bevált gyakorlatok
- Minden webhook-adattartalmat dolgozzon fel – minden üzenet tartalmazhat új nyomonkövetési eseményt vagy küldeményadat-frissítést.
- Egyesítse a növekményes frissítéseket a meglévő küldeményrekordjába.
- Figyelje mind a
scanEvent, mind apreviousEventsértékét, hogy rögzíthesse a küldemény teljes előzményeit. - Az ügyfélértesítéseket aktiválja üzleti szabályokkal, ne csupán nyers események alapján.
- Hagyjon időt a várható kézbesítési kiegészítő adatok (pl. PPOD, SPOD, GPS) megérkezésére, mielőtt értesítené az ügyfeleket.
- Tervezzen idempotens, hibatűrő feldolgozást, amely kezeli a duplikált és soron kívül érkező üzeneteket.
Gyakori integrációs problémák
- Feltételezi, hogy minden adattartalom egy új nyomonkövetési mérföldkövet jelent.
- Felülírja küldeményrekordot a legújabb adattartalommal.
- Kizárólag a
scanEventértékre támaszkodik. - Értesítéseket aktivál kizárólag az
eventCodeérték alapján. - Feltételezi, hogy az első kézbesített adattartalom minden kézbesítési részletet tartalmaz.
- Feltételezi, hogy a webhook-üzenetek csak egyszer vagy időrendi sorrendben érkeznek.
Összegzés
Minden webhook-adattartalmat a küldeményállapot frissítéseként dolgozzon fel. Tárolja és egyesítse a küldeményfrissítéseket, figyelje a scanEvent és a previousEvents értékét, és üzleti szabályok alapján határozza meg, mikor frissítse az alkalmazásokat vagy értesítse az ügyfeleket.
Ez a megközelítés hozzájárul ahhoz, hogy pontosan nyomon követhetők legyenek a küldemények, teljes legyen a nyomonkövetési előzmény, és megalapozottabb legyen az ügyfelekkel folytatott kommunikáció.
