Handleiding voor webhook-ontwikkelaars
Inleiding
FedEx Tracking Webhooks bieden gedurende de volledige levenscyclus van de zending bijna in real time updates over zendingen.
In tegenstelling tot API's voor het traceren van zendingen, waarvoor applicaties de status van een zending moeten opvragen, versturen webhooks automatisch updates over zendingen zodra er nieuwe informatie beschikbaar komt.
Deze handleiding behandelt:
- Drie integratieprincipes
- Zo werken webhooks
- Webhook-laadvermogens verwerken
- Klantmeldingen
- Tijdstempels
- Best practices en veelvoorkomende integratieproblemen
Drie integratieprincipes
Succesvolle webhook-integraties volgen drie principes.
Beschouw het laadvermogen van elke webhook als een statusupdate van een zending
Ga er niet van uit dat elk laadvermogen een nieuwe mijlpaal bij het traceren vertegenwoordigt. FedEx publiceert een nieuw laadvermogen telkens wanneer er nieuwe informatie over een zending beschikbaar komt.
Een laadvermogen kan het volgende bevatten:
- Een nieuwe trackinggebeurtenis
- Bijgewerkte leveringsvoorspellingen
- Informatie over bewijs van aflevering
- Gegevens geadresseerde
- Overige wijzigingen in zendingsgegevens
Meerdere laadvermogens kunnen dezelfde mijlpaal bij het traceren delen, terwijl ze verschillende informatie over de zending bevatten.
Zendingsgegevens worden opgeslagen en samengevoegd
Elk laadvermogen kan nieuwe of bijgewerkte zendingsinformatie bevatten. Webhook-laadvermogens worden opgeslagen en nieuwe informatie wordt samengevoegd met de bestaande gegevens in het bestaande zendingsrecord.
Overschrijf het bestaande zendingsrecord niet met het meest recente laadvermogen. Behoud in plaats daarvan eerder ontvangen zendingsgegevens en verwerk nieuwe informatie, zodat gedurende de volledige levenscyclus van de zending een volledig en actueel zendingsrecord behouden blijft.
Gebruik bedrijfsregels om acties aan te sturen
Gebruik bedrijfsregels om te bepalen wanneer systemen moeten worden bijgewerkt of klanten moeten worden geïnformeerd.
Activeer geen acties uitsluitend op basis van een gebeurteniscode. Evalueer voordat u klantgerichte applicaties bijwerkt of meldingen verzendt:
- Mijlpalen bij het traceren
- Zendingsbeschikbaarheid
- Timing van meldingen
- Bedrijfsvereisten
Aanbevolen verwerkingsmodel
In het volgende diagram ziet u hoe de drie principes voor webhook-integratie samenwerken in een typische implementatie. Elk webhook-laadvermogen wordt verwerkt als een statusupdate van een zending, samengevoegd in een centraal zendingsrecord en aan de hand van bedrijfsregels geëvalueerd voordat applicaties worden bijgewerkt of klantmeldingen worden verzonden.
Zo werken webhooks
FedEx publiceert een nieuw laadvermogen voor de webhook telkens wanneer informatie over een zending verandert of beschikbaar komt. Een zending kan gedurende de hele levenscyclus meerdere laadvermogens genereren, waaronder meerdere laadvermogens die verband houden met dezelfde mijlpaal tijdens het traceren.
Aanvullende laadvermogens kunnen onder meer het volgende bevatten:
- Statussen bij het traceren: opgehaald, onderweg, onderweg voor bezorging en bezorgd.
- Zendinggegevens: Bewijs van aflevering (PPOD), Bewijs met handtekening (SPOD), GPS-bewijs van aflevering (GPS POD) en gegevens van de ontvanger.
- Updates van leveringsvoorspellingen: wijzigingen in de verwachte leverdatum en -tijd.
- Afleveruitzonderingen: updates en redenen voor zending- en afleveruitzonderingen.
- Updates van metadata van zendingen: adresupdates, referenties en servicegegevens.
- Operationele correcties: aanvullende mijlpalen bij het traceren en updates van
previousEvents.
Opmerking: fotobewijs is niet beschikbaar voor alle bezorgde zendingen. De beschikbaarheid is afhankelijk van het type bezorging, de vereisten voor handtekening en andere bedrijfsregels.
Elk laadvermogen vertegenwoordigt de laatst bekende status van de zending. Verwerk elk laadvermogen om ervoor te zorgen dat uw zendingsrecord volledig en actueel blijft.
Inzicht in webhook-updates
Het volgende voorbeeld laat zien hoe er voor dezelfde zending gedurende de hele levenscyclus meerdere webhook-laadvermogens kunnen worden gegenereerd. Sommige laadvermogens introduceren een nieuwe mijlpaal bij het traceren. Andere voegen zendingsinformatie toe, zoals leveringsvoorspellingen, gegevens over het bewijs van aflevering of zendingsgegevens.
Belangrijk: er kunnen meerdere webhook-laadvermogens worden gegenereerd voor dezelfde mijlpaal bij het traceren. Verwerk elk laadvermogen om ervoor te zorgen dat nieuwe informatie over de zending wordt opgenomen in het record van de zending.
Webhook-laadvermogens verwerken
Verwerk elk webhook-laadvermogen als een statusupdate van een zending.
Ga er niet van uit dat elk webhook-laadvermogen een nieuwe mijlpaal bij het traceren vertegenwoordigt. FedEx verstuurt een nieuw laadvermogen telkens wanneer er nieuwe informatie over een zending beschikbaar komt. Een geleverde zending kan bijvoorbeeld aanvullende laadvermogens genereren wanneer informatie over het bewijs van aflevering, informatie over de ontvanger of andere zendinggegevens worden toegevoegd of bijgewerkt.
Stel bij elk laadvermogen de vraag:
- Welke mijlpaal in de zendingstracering is gewijzigd?
- Welke zendingsgegevens zijn gewijzigd?
- Heeft de update invloed op een klantgerichte applicatie?
- Leidt de update tot een melding?
Verwerk de verzendgeschiedenis
Monitor zowel scanEvent als previousEvents.
scanEventbevat de huidige mijlpaal bij het traceren die bij het laadvermogen hoort.previousEventsbevat aanvullende gegevens over de geschiedenis van de zending, waaronder mijlpalen die mogelijk niet worden weergegeven als de huidigescanEvent.
Sommige mijlpalen bij het traceren verschijnen in previousEvents in plaats van dat ze als een nieuwe scanEvent worden gepubliceerd. Applicaties die alleen scanEvent verwerken, kunnen updates van zendingen missen en onvolledige geschiedenissen van zendingen genereren. Verwerk beide verzamelingen om een volledig beeld van de zending te krijgen.
Houd een zendingsrecord bij
Webhook-laadvermogens worden opgeslagen en nieuwe informatie wordt samengevoegd met de bestaande gegevens in het bestaande zendingsrecord.
Een volledig record van de zending biedt bijna in real time inzicht in:
- Dashboards voor het traceren van zendingen
- Klantenserviceapplicaties
- Orderbeheersystemen (OMS)
Werk het zendingsrecord bij met elk laadvermogen om het meest nauwkeurige en volledige beeld van de zending te behouden.
Klantmeldingen
Kies een meldingsstrategie op basis van uw bedrijfsvereisten en het gewenste detailniveau van de zending dat u wilt verstrekken.
FedEx Tracking Webhooks sturen vrijwel in real time updates over mijlpalen in het traceringsproces en wijzigingen in de zendingsgegevens. Gebruik bedrijfsregels om te bepalen welke updates relevant zijn voor uw bedrijf en welke kunnen worden genegeerd.
Veelvoorkomende meldingsstrategieën zijn onder meer:
Meldingen, bijna in real time
Verzend meldingen onmiddellijk nadat er een mijlpaal bij het traceren plaatsvindt.
Voordelen
- Snelste klantcommunicatie
- Laagste latentie
Aandachtspunt: aanvullende informatie over de zending is mogelijk nog niet beschikbaar.
Uitgebreide meldingen
Wacht enkele minuten nadat een mijlpaal bij het traceren is bereikt, zodat aanvullende informatie over de zending kan binnenkomen.
Wacht bijvoorbeeld na het bereiken van de status 'Bezorgd' enkele minuten om het volgende te verzamelen:
- Bewijs van aflevering (POD)
- Bewijs met handtekening (SPOD)
- GPS-bewijs van aflevering
- Gegevens geadresseerde
Voordelen
- Meer volledige updates over zendingen voor klanten
- Minder follow-upmeldingen
- Minder contact met de klantenservice
FedEx raadt aan ongeveer vijf minuten te wachten nadat de status 'Bezorgd' is bereikt, omdat informatie over het bewijs van aflevering vaak kort na de eerste bezorggebeurtenis wordt toegevoegd.
Aanbevelingen voor de timing van meldingen
De timing van meldingen verschilt per klant en gebruikssituatie. De volgende aanbevelingen worden echter vaak gebruikt voor meldingen aan ontvangers na aankoop. Voor andere soorten meldingen (zakelijke gebruikers, medewerkers van de klantenservice, enzovoort) kiest u een meldingsstrategie die bij uw gebruikssituatie past.
- Verwachte levering: wacht ongeveer 15 minuten nadat zowel de toegezegde leverdatum als de eerste verwachte leverdatum (EDD) beschikbaar zijn.
- Onderweg voor bezorging: verzend direct of volgens uw werktijden (bijvoorbeeld dagelijks om 8.00 uur).
- Bezorgd: wacht ongeveer 5 minuten zodat aanvullende bezorginformatie kan binnenkomen.
- Bezorgpoging: pas dezelfde aanpak toe als bij Bezorgd, zodat de bezorginformatie kan binnenkomen.
Meldingsregels opstellen op basis van bedrijfsgegevens
Niet voor elke update van een zending is een melding nodig. Stel meldingsregels op die aansluiten bij uw bedrijfsvereisten.
Aanbevolen aanpak
Genereer geen meldingen uitsluitend op basis van eventCode.
Beoordelen:
- Mijlpaal bij het traceren
- Vereiste zendingsgegevens
- Bedrijfsregels
Genereer meldingen alleen wanneer de vereiste informatie beschikbaar is.
Deze aanpak helpt het volgende voorkomen:
- Dubbele meldingen
- Ontbrekende bezorginformatie
- Onvolledige leveringsberichten
- Onnodige follow-upmeldingen
Tijdstempels
Gebruik de juiste tijdstempel op basis van uw toepassing.
eventCreateTime: wanneer de gebeurtenis van de zending heeft plaatsgevonden. Gebruik dit voor de traceergeschiedenis die zichtbaar is voor klanten.- Tijdstip waarop het bericht is verzonden: toen FedEx het laadvermogen van de webhook heeft verzonden. Gebruik dit alleen voor foutopsporing en monitoring, niet voor klantervaringen.
eventCreateTime geeft aan wanneer de zendingsgebeurtenis heeft plaatsgevonden. FedEx werkt deze waarde niet bij wanneer later aanvullende informatie over de zending wordt toegevoegd. Een bezorgde gebeurtenis behoudt bijvoorbeeld de oorspronkelijke eventCreateTime, ook als latere laadvermogens informatie over het bewijs van aflevering of andere updates over de zending toevoegen. Daarom moet eventCreateTime worden gebruikt om vast te stellen wanneer de gebeurtenis heeft plaatsgevonden, en niet wanneer gerelateerde informatie over de zending is toegevoegd.
In sommige gevallen is het tijdstip van een gebeurtenis mogelijk niet beschikbaar. Wanneer dit gebeurt, kan de tijdstempel de standaardwaarde 00:00:00 bevatten. Aanvullende laadvermogens kunnen een nauwkeuriger tijdstempel bevatten zodra deze beschikbaar is.
Best practices en veelvoorkomende integratieproblemen
Best practices
- Verwerk elk webhook-laadvermogen, aangezien elk bericht een nieuwe traceergebeurtenis of een gegevensupdate van een zending kan bevatten.
- Verwerk incrementele updates in uw bestaande zendingsrecord.
- Monitor zowel
scanEventalspreviousEventsom de volledige geschiedenis van de zending vast te leggen. - Activeer klantmeldingen op basis van bedrijfsregels, niet alleen op basis van onbewerkte gebeurtenissen.
- Als u klanten informeert, houd er dan rekening mee dat het even kan duren voordat er extra informatie beschikbaar is (bijvoorbeeld PPOD, SPOD, GPS).
- Ontwerp niet veranderende, veerkrachtige verwerking die dubbele berichten en berichten die niet in de juiste volgorde aankomen afhandelt.
Veelvoorkomende integratieproblemen
- Ervan uitgaan dat elk laadvermogen een nieuwe mijlpaal bij het traceren vertegenwoordigt.
- Het zendingsrecord overschrijven met het meest recente laadvermogen.
- Alleen vertrouwen op
scanEvent. - Meldingen activeren uitsluitend op basis van
eventCode. - Ervan uitgaan dat het eerst bezorgde laadvermogen alle bezorgdetails bevat.
- Ervan uitgaan dat webhookberichten slechts één keer of in chronologische volgorde binnenkomen.
Overzicht
Verwerk elk webhook-laadvermogen als een statusupdate van een zending. Sla updates van zendingen op en voeg ze samen, houd zowel scanEvent als previousEvents in de gaten en gebruik bedrijfsregels om te bepalen wanneer applicaties worden bijgewerkt of klanten op de hoogte worden gesteld.
Met deze aanpak krijgt u nauwkeurig inzicht in zendingen, een volledige traceergeschiedenis en beter geïnformeerde communicatie met klanten.
