Funktionsweise von Advanced Integrated Visibility
Übersicht für Advanced Integrated Visibility Webhook
Mit dem Advanced Integrated Visibility Webhook kann FedEx für Sendungen, die mit bestimmten FedEx Kundennummern verknüpft sind, Tracking-Ereignisdaten nahezu in Echtzeit an eine bestimmte Ziel-URL senden.
Um diese Funktionalität zu nutzen, muss ein FedEx-Admin oder DI-Admin ein Advanced Integrated Visibility Webhook-Projekt erstellen.
Navigationsoptionen
Sie haben zwei Möglichkeiten, um die Seite Advanced Integrated Visibility Webhooks aufzurufen:
Option 1: Über „Meine Projekte“
- Navigieren Sie im linken Navigationsbereich zu „Meine Projekte“.
- Klicken Sie auf die Registerkarte „Webhooks“.
Option 2: Über den API-Katalog
- Rufen Sie im linken Navigationsbereich den API-Katalog auf.
- Verwenden Sie die Suchleiste, um Advanced Integrated Visibility zu finden, oder nehmen Sie diese Auswahl im Bereich FILTER vor.
- Wählen Sie auf der Webhook-Karte eine der folgenden Möglichkeiten aus:
- Klicken Sie auf Dokumente → und dann auf + Webhooks verwalten
Anzeige eines Projekts für Advanced Integrated Visibility-Abonnements auf Basis der Sendungsverfolgungsnummer
1. Persönlicher Zugriff und Einrichtung für FedEx
- Ein*e FedEx Administrator*in oder FedEx Mitarbeiter*in startet den Einrichtungsprozess.
- Das Organisationsprofil wird von einem*einer benannten Administrator*in im Auftrag der CSP-Kund*innen erstellt.
- Eine berechtigte US-basierte Abrechnungskontonummer wird auf Organisationsebene vom Administrator im Namen des Kunden hinzugefügt.
- Der Administrator, der diese Einrichtung vornimmt, muss über die entsprechenden Berechtigungen zur Verwaltung von Konfigurationen auf Organisationsebene verfügen.
2. Workflow für Sendungsverfolgungsnummer-Abonnement anzeigen
2.1 Das Abonnement anzeigen
- Sobald ein*e FedEx-Administrator*in oder -Vertreter*in ein Projekt erstellt hat, können Benutzer*innen das zugehörige Projekt „Advanced Integrated Visibility-Abonnement auf Basis der Sendungsverfolgungsnummer“ in ihrem Dashboard einsehen.
2. Funktionen anzeigen
- Benutzer*innen können die verfügbaren Funktionen im Zusammenhang mit dem Abonnementprojekt erkunden, um sie besser zu verstehen und zu nutzen.
Funktionsbeschreibungen
| Feldname | Beschreibung |
|---|---|
| Zustellnachweis | Bestätigt, dass eine Sendung erfolgreich zugestellt wurde. Inklusive:
|
| Vorauss. Zustellg. | Unterstützt die Empfänger bei der Planung durch folgende Leistungen:
|
| Sendungsverfolgungsereignisse | Ermöglicht die Auswahl einer oder mehrerer Ereigniskategorien zum Erhalt von Benachrichtigungen:
|
Auf der Detailseite werden folgende Informationen angezeigt:
| Feldname | Beschreibung |
|---|---|
| Webhook-Projektname | Ein eindeutiger, nicht leerer Name für Ihr Webhook-Projekt. Ein vorgeschlagener Name wird automatisch ausgefüllt, kann aber bearbeitet werden. Dieser Name darf in keinem anderen Webhook wiederholt werden. |
| Ziel-URL | Der sichere HTTPS-Endpunkt, an den FedEx Tracking-Ereignisdaten senden wird. Anforderungen:
|
| Sicherheits-Token | Ein gemeinsamer geheimer Schlüssel zur Authentifizierung und Validierung von Webhook-Antworten mittels HMAC. Anforderungen:
|
| Payload-Sprache (Land) | Wählen Sie aus der Dropdownliste die bevorzugte Sprache für die Übersetzung Ihrer Tracking-Daten aus. |
| Sendungsverfolgungstyp | Wählen Sie aus, wie die Tracking-Daten bereitgestellt werden sollen:
|
| E-Mail-Adresse | Geben Sie eine gültige E-Mail-Adresse an, um Benachrichtigungen zu erhalten. |
| E-Mail-Sprache (Land) | Wählen Sie die bevorzugte Sprache für E-Mail-Benachrichtigungen aus. Hinweis: Nur US-Gebietsschemas werden unterstützt (z. B. en-US, es-US). |
Schritt-für-Schritt-Prozess
4. Ein Abonnementprojekt erstellen
- Befolgen Sie Schritte aus dem vorherigen Abschnitt oder konsultieren Sie den Leitfaden für die ersten Schritte.
2. OAuth-Token generieren
- Sie benötigen ein OAuth-Token, um API-Aufrufe vorzunehmen.
- Verwenden Sie die Autorisierungs-API, um das Token zu generieren.
- Weitere Informationen finden Sie in der Dokumentation zur Autorisierungs-API im API-Katalog.
6. Zugriff auf API-Dokumentation
- Klicken Sie im linken Navigationsmenü auf Projektdetails.
- Scrollen Sie auf der Registerkarte „Produktionsschlüssel“ nach unten, um die Dokumentation der Advanced Integrated Visibility-Abonnement-API für Sendungsverfolgungsnummern zu finden.
Übersicht über API-Endpunkte
| Endpunkt | Zweck |
|---|---|
| Sendungsverfolgungsnummer – Zuordnung | Fügen Sie Sendungsverfolgungsnummern zu einem Webhook-Abonnement hinzu oder entfernen Sie sie daraus. Dies ist ein asynchroner Job. In der Antwort wird eine Job-ID zurückgegeben. |
| Sendungsverfolgungsnummer – Jobdetails | Stellt Details zu einer bestimmten Job-ID bereit, wie z. B., wie viele Sendungsverfolgungsnummern erfolgreich hinzugefügt wurden oder noch verarbeitet werden. |
| Sendungsverfolgungsnummer —Jobstatus | Gibt eine Zusammenfassung aller aktuell bearbeiteten Aufträge zurück. |
Verwenden Sie das OAuth-Token aus Schritt 2 mit dem Endpunkt Sendungsverfolgungsnummer-Verknüpfung, um Sendungsnummern zu Ihrem Webhook hinzuzufügen.
Validierungsregeln
- Der Webhook-Name muss eindeutig sein.
- Die Ziel-URL muss dem standardmäßigen syntaktischen Format entsprechen.
- Alle erforderlichen Felder müssen ausgefüllt werden.
- Mindestens eine gültige FedEx-Versandkontonummer muss verknüpft sein.
Validierungsergebnisse
| Status | Details |
|---|---|
| Erfolgreich | Eine Bestätigungsnachricht wird angezeigt: «< > wurde erfolgreich erstellt. Es kann bis zu 10 Minuten dauern, bis Änderungen in Kraft treten. |
| Nicht erfolgreich | Erhält FedEx eine andere Antwort als 200 (OK) oder 202 (Akzeptiert), wird die Validierung der Webhook-Zielort-URL als fehlgeschlagen betrachtet. |
