Hoe Advanced Integrated Visibility werkt
Overzicht van de webhook Advanced Integrated Visibility
De Advanced Integrated Visibility-webhook stelt FedEx in staat om beveiligde nagenoeg in realtime traceergegevens te verzenden naar een opgegeven bestemmings-URL voor zendingen die gekoppeld zijn aan aangewezen FedEx-accountnummer(s).
Om deze functionaliteit te gebruiken, moet een FedEx-beheerder of DI-beheerder een Advanced Integrated Visibility-webhookproject aanmaken.
Navigatieopties
U kunt de pagina Advanced Integrated Visibility-webhooks op twee manieren openen:
Optie 1: via Mijn projecten
- Navigeer naar Mijn projecten vanuit het navigatiepaneel aan de linkerkant.
- Klik op het tabblad Webhooks.
Optie 2: via API-catalogus
- Ga naar de API-catalogus vanuit het navigatiemenu aan de linkerkant.
- Gebruik de zoekbalk om Advanced Integrated Visibility te vinden of selecteer deze in de sectie FILTERS.
- Kies op de kaart Webhook een van de volgende opties:
- Klik op Documenten → en vervolgens op + Webhooks beheren
Een project voor een op tracking-nummer gebaseerd abonnement voor Advanced Integrated Visibility bekijken
1. Persoonlijke toegang en instellingen van FedEx
- Een FedEx-beheerder of FedEx-medewerker zal het installatieproces starten.
- Het organisatieprofiel wordt aangemaakt door een aangewezen beheerder namens CSP-klanten.
- Een geldig, in de VS gevestigd facturatie-accountnummer wordt op organisatieniveau door de beheerder namens de klant toegevoegd.
- De beheerder die deze configuratie uitvoert, moet over de juiste rechten beschikken om configuraties op organisatieniveau te beheren.
2. Workflow voor abonnementen op basis van tracking-nummer bekijken
2.1 Het abonnement weergeven
- Zodra een FedEx-beheerder of -medewerker een project aanmaakt, kunnen gebruikers het bijbehorende project voor abonnementen op basis van tracking-nummer voor Advanced Integrated Visibility op hun dashboard bekijken.
2. Functies bekijken
- Gebruikers kunnen de beschikbare functies van het abonnementsproject verkennen voor een beter begrip en gebruik ervan.
Functiebeschrijvingen
| Veldnaam | Omschrijving |
|---|---|
| Bewijs van aflevering | Bevestigt dat een zending succesvol is afgeleverd. Omvat:
|
| Verwachte levering | Helpt ontvangers plannen door te voorzien in:
|
| Trackinggebeurtenissen | Hiermee kunt u één of meer gebeurteniscategorieën selecteren om meldingen te ontvangen:
|
Op de pagina 'Details' wordt de volgende informatie weergegeven:
| 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 trackinggegevens zal verzenden. Vereisten:
|
| Beveiligingstoken | Een gedeeld geheim dat wordt gebruikt om webhook-reacties te authenticeren en valideren via HMAC. Vereisten:
|
| Taal van het laadvermogen (land) | Selecteer de voorkeurstaal voor de vertaling van de traceergegevens in de keuzelijst. |
| Trackingtype | Kies hoe traceergegevens geleverd moeten worden:
|
| 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). |
Stapsgewijs proces
4. Maak een abonnementsproject aan
- Gebruik de stappen uit het vorige hoofdstuk of raadpleeg de Gids om aan de slag te gaan.
5. Een OAuth-token genereren
- 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.
6. Toegang tot API-documentatie
- Klik in het navigatiemenu aan de linkerkant op Projectgegevens.
- 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
- Webhook-namen moeten 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 reactie ontvangt die afwijkt van 200 (OK) of 202 (Geaccepteerd), wordt de validatie van de webhook-bestemmings-URL als mislukt beschouwd. |
