Fedex Logo

WEBHOOK
AANMAKEN WEBHOOKS BEHEREN

Hoe Advanced Integrated Visibility werkt

Met de Advanced Integrated Visibility-webhook kan FedEx veilige, nagenoeg in realtime trackingupdates naar een specifieke URL sturen. Deze updates zijn voor zendingen die aan een of meer FedEx-accountnummers zijn gekoppeld. Om deze functie te gebruiken, moet u een Advanced Integrated Visibility-webhookproject aanmaken.

Toegang tot de pagina Advanced Integrated Visibility

U kunt op twee manieren toegang krijgen tot de instellingen voor Advanced Integrated Visibility:

Optie 1: via Mijn projecten

    1. Ga naar Mijn projecten in het navigatievenster aan de linkerkant.

    2. Klik op het tabblad Webhooks .

    3. Selecteer +EEN WEBHOOKPROJECT AANMAKEN.

Optie 2: via de API-catalogus

    1. Open de API-catalogus aan de linkerkant van het navigatiescherm.

    2. Zoek naar Advanced Integrated Visibility.

    3. Gebruik het WEBHOOK-filter om de juiste kaart te vinden.

    4. Op de kaart:

  •  Klik op Overzicht, vervolgens op de knop Documentatie , en kies +EEN WEBHOOKPROJECT AANMAKEN.
  •  Of ga naar DOCUMENTEN en klik op +EEN WEBHOOKPROJECT AANMAKEN.

 

Stap 1: selecteer het bedrijfstype

Klik op +EEN PROJECT AANMAKEN en kies uw bedrijfstype uit de keuzelijst:

    1. Verzendt met FedEx en moet FedEx-webhook integreren in het bedrijfssysteem.

    2. Verkoopt of levert een softwareoplossing die FedEx-gegevens gebruikt en geen gecertificeerde FedEx Compatible Provider is.

    3. Is een gecertificeerde FedEx Compatible Provider.

 

Selecteer vervolgens Op tracking-nummer gebaseerd abonnement voor Advanced Integrated Visibility als uw abonnementstype.

Een op tracking-nummer gebaseerd abonnement voor Advanced Integrated Visibility maken

U kunt een op tracking-nummer gebaseerd abonnement voor Advanced Integrated Visibility instellen om veilige, nagenoeg in realtime trackingupdates te ontvangen voor een of meer FedEx-tracking-nummers. Deze updates worden naar een door u opgegeven bestemmings-URL gestuurd.

 

Stappen voor het aanmaken van het abonnement

Het proces omvat vier belangrijke stappen:

    1. Project configureren

    2. Projectgegevens invoeren

    3. Gegevens bevestigen en voorwaarden accepteren

    4. Tracking-nummers toevoegen

 

Stapsgewijze instructies

    1. Op de pagina Webhook configureren:

         Controleer het facturatie-accountnummer

         Het standaard facturatie-accountnummer voor uw organisatie wordt weergegeven.

         Om dit te wijzigen:

  •  Klik op FACTURATIE-ACCOUNT TOEVOEGEN AAN UW ORGANISATIE (als u slechts één account hebt), of
  •  Klik op EEN ANDER FACTURATIE-ACCOUNT SELECTEREN (als u meerdere accounts hebt).

 

Let op: ga voor prijsinformatie naar de pagina Overzicht Advanced Integrated Visibility.

 

2. Functies selecteren

  •  Kies de functies die u nodig hebt.
  •  Klik op Volgende om door te gaan.

Tip: om meer te weten te komen over elke functie, klikt u op het help-pictogram (?) ernaast.

Functiebeschrijvingen

Veldnaam Omschrijving
Bewijs van aflevering Bevestigt dat een zending succesvol is afgeleverd. Omvat:
  • Bewijs van aflevering met foto (PPODA): biedt een foto waarop de exacte afleverlocatie te zien is.
  • Bewijs met handtekening (SPOD): geeft een afbeelding weer van de handtekening, naam, bezorgdatum, tijd en locatie van de ontvanger.
Verwachte levering Helpt ontvangers plannen door te voorzien in:
  • Verwachte leverdatum (EDD)
  • Verwachte leverperiode (EDTW)
Trackinggebeurtenissen Hiermee kunt u één of meer gebeurteniscategorieën selecteren om meldingen te ontvangen:
  • Verzenden
  • Onderweg
  • Aflevering
  • Uitzonderingen

 

Geef de volgende informatie op de pagina Gegevens invoeren op:

Veldnaam Omschrijving
Naam webhookproject Een unieke, niet-lege naam voor uw webhookproject. Een voorgestelde naam wordt automatisch ingevuld, maar kan worden aangepast. Deze naam mag in geen enkele andere webhook worden herhaald.
Bestemmings-URL Het beveiligde HTTPS-eindpunt waarnaar FedEx traceergegevens zal verzenden.
Vereisten:
  • Moet geldig zijn en werken
  • Moet de gestandaardiseerde syntaxis volgen
  • Mag geen fedex.com of bijbehorende subdomeinen bevatten
  • Kan hergebruikt worden op meerdere webhooks
Ga naar de sectie 'Bedrijfsregels en best practices' voor meer informatie.
Beveiligingstoken Een gedeeld geheim dat wordt gebruikt om webhook-reacties te authenticeren en valideren via HMAC.
Vereisten:
  • 26–100 tekens
  • Moet minstens 1 hoofdletter, 1 kleine letter en 1 cijfer bevatten
  • Kan hergebruikt worden op meerdere webhooks
Taal van het laadvermogen (land) Selecteer de voorkeurstaal voor de vertaling van de traceergegevens in de keuzelijst.
Trackingtype Kies hoe traceergegevens geleverd moeten worden:
  • Gedetailleerd traceren – Volledige gebeurtenisgeschiedenis
  • Gebeurtenisspecifiek traceren – Alleen de meest recente gebeurtenis
E-mailadres Geef een geldig e-mailadres op om meldingen te ontvangen.
Taal van e-mailadres (land) Selecteer de voorkeurstaal voor e-mailmeldingen.
Let op: alleen Amerikaanse taalvarianten worden ondersteund (bijv. en-US, es-US).

3. Op de pagina Gegevens bevestigen:

  •  Bekijk de details van uw webhookproject.
  •  Lees en accepteer de Algemene Voorwaarden.
  •  Klik op Aanmaken om de installatie van het webhook-project te voltooien.

4. Zodra uw aanvraag succesvol is ingediend:

  •  Zal FedEx een nieuw webhookproject aanmaken.
  •  Ontvangt u productiesleutels voor de API voor het op tracking-nummer gebaseerde abonnement voor Advanced Integrated Visibility.
  •  U kunt deze API gebruiken om tracking-nummers te koppelen aan uw project.

Ga voor meer informatie naar de documentatiepagina voor de API voor het op tracking-nummer gebaseerde abonnement voor Advanced Integrated Visibility.

Een tracking-nummer aan een webhook toevoegen

Om een tracking-nummer aan uw webhookabonnement toe te voegen met behulp van de API voor het op tracking-nummer gebaseerde abonnement voor Advanced Integrated Visibility, volgt u deze stappen:

 

Stapsgewijs proces

1. Maak een abonnementsproject aan

· Volg de stappen uit het vorige gedeelte of raadpleeg de Gids om aan de slag te gaan.

2. Genereer een OAuth-token

  •  U hebt een OAuth-token nodig om API-aanroepen te doen.
  •  Gebruik de Autorisatie-API om het token te genereren.
  •  Ga naar de autorisatie-API-documentatie in de API-catalogus voor gedetailleerde stappen.

3. Toegang tot API-documentatie

  • Klik in het linker navigatiemenu op Projectdetails.
  • Op het tabblad Productiesleutels scrolt u om de documentatie voor het op tracking-nummer gebaseerde abonnement voor Advanced Integrated Visibility te vinden.

Overzicht API-eindpunten

Eindpunt Doel
Koppeling van tracking-nummers Tracking-nummers toevoegen aan of verwijderen uit een webhookabonnement. Dit is een asynchrone taak. In de respons wordt een taak-ID geretourneerd.
Taakgegevens voor tracking-nummer Biedt informatie over een bepaalde taak-ID, zoals hoeveel tracking-nummers er zijn toegevoegd of hoeveel er nog steeds worden verwerkt.
Taakstatus voor tracking-nummer Geeft een overzicht van alle taken die momenteel worden verwerkt.

 

Gebruik het OAuth-token uit stap 2 met het eindpunt voor koppeling van tracking-nummers om tracking-nummers aan uw webhook toe te voegen.

Validatieregels

  •  De naam van de webhook moet uniek zijn.
  •  De bestemmings-URL moet de standaard syntactische indeling volgen.
  •  Alle verplichte velden moeten worden ingevuld.
  •  Er moet minimaal één geldig FedEx-verzendaccountnummer gekoppeld zijn.

 

Validatieresultaten

Status Details
Succesvol Er wordt een bevestigingsbericht weergegeven:
'<> succesvol aangemaakt. Het kan maximaal 10 minuten duren voordat wijzigingen zijn verwerkt.'
Onsuccesvol Als FedEx een andere reactie ontvangt dan 200 (OK) of 202 (Geaccepteerd), wordt de validatie van de webhook-bestemmings-URL als mislukt beschouwd.
CLOSE

Response

Copy