Funktionsweise von Advanced Integrated Visibility
Mit dem Advanced Integrated Visibility-Webhook kann FedEx sichere, nahezu in Echtzeit erfolgende Tracking-Updates an eine bestimmte URL senden. Diese Updates sind für Sendungen, die mit einer oder mehreren FedEx Kundennummern verknüpft sind. Um diese Funktion zu nutzen, müssen Sie ein Advanced Integrated Visibility-Webhook-Projekt erstellen.
So greifen Sie auf die Seite „Advanced Integrated Visibility“ zu
Sie können das Advanced Integrated Visibility-Setup auf zwei Arten erreichen:
Option 1: Über „Meine Projekte“
1. Wählen Sie im linken Navigationsbereich Meine Projekte aus.
2. Klicken Sie auf die Registerkarte Webhooks.
3. Wählen Sie +EIN WEBHOOK-PROJEKT ERSTELLEN.
Option 2: Über den API-Katalog
1. Öffnen Sie den API-Katalog im linken Navigationsbereich.
2. Suchen Sie nach Advanced Integrated Visibility.
3. Verwenden Sie den WEBHOOK-Filter, um die richtige Karte zu finden.
4. Auf der Karte:
- Klicken Sie auf Übersicht, dann auf die Schaltfläche Dokumentation und wählen Sie +EIN WEBHOOK-PROJEKT ERSTELLEN.
- Oder gehen Sie zu DOCS und klicken Sie auf +EIN WEBHOOK-PROJEKT ERSTELLEN.
Schritt 1: Unternehmenstyp auswählen
Klicken Sie auf +EIN PROJEKT ERSTELLEN und wählen Sie Ihren Unternehmenstyp aus dem Dropdown-Menü:
1. Versand mit FedEx, Integration von FedEx Webhook in das System erforderlich
2. Verkauf oder Bereitstellung einer Softwarelösung mit FedEx Daten, kein zertifizierter FedEx Compatible Provider.
3. Ist ein zertifizierter FedEx Compatible Provider.
Wählen Sie anschließend Advanced Integrated Visibility-Abonnement auf Basis der Kundennummer als Abonnementtyp aus.
Ein Abonnement für eine Advanced Integrated Visibility-Sendungsverfolgungsnummer erstellen
Sie können ein Abonnement für eine Advanced Integrated Visibility-Sendungsverfolgungsnummer einrichten, um in nahezu Echtzeit sichere Tracking-Updates für eine oder mehrere FedEx-Sendungsnummern zu erhalten. Diese Updates werden an eine von Ihnen angegebene Ziel-URL gesendet.
Schritte zum Erstellen des Abonnements
Dieser Prozess umfasst vier Hauptschritte:
1. Projekt konfigurieren
2. Projektdetails eingeben
3. Details bestätigen und Bedingungen akzeptieren
4. Sendungsnummern hinzufügen
Schritt-für-Schritt-Anleitung
1. Auf der Seite „Webhook konfigurieren“:
Überprüfen Sie die Abrechnungskontonummer
Die Standard-Abrechnungskontonummer Ihrer Organisation wird angezeigt.
So können Sie die Angabe ändern:
- Klicken Sie auf ABRECHNUNGSKONTO ZU IHRER ORGANISATION HINZUFÜGEN (wenn Sie nur ein Konto haben), oder
- Klicken Sie auf EIN WEITERES ABRECHNUNGSKONTO AUSWÄHLEN (falls Sie mehrere Konten haben).
Hinweis: Preisinformationen finden Sie auf der Seite Übersicht über Advanced Integrated Visibility.
2. Funktionen auswählen
- Wählen Sie die Funktionen, die Sie benötigen.
- Klicken Sie auf Weiter, um fortzufahren.
Tipp: Um mehr über jede Funktion zu erfahren, klicken Sie auf das Hilfesymbol (?) daneben.
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:
|
Geben Sie auf der Seite Details eingeben die folgenden Informationen ein:
| 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). |
3. Auf der Seite Details bestätigen:
- Überprüfen Sie die Details Ihres Webhook-Projekts.
- Überprüfen und akzeptieren Sie die Allgemeinen Geschäftsbedingungen.
- Klicken Sie auf Erstellen, um die Webhook-Projekteinrichtung fertigzustellen.
4. Sobald Ihre Anfrage erfolgreich übermittelt wurde:
- FedEx wird ein neues Webhook-Projekt erstellen.
- Sie erhalten Produktionsschlüssel für die Advanced Integrated Visibility-Abonnement-API für Sendungsverfolgungsnummern.
- Mithilfe dieser API können Sie Ihrem Projekt Sendungsverfolgungsnummern zuordnen.
Weitere Informationen finden Sie auf der Dokumentation zur Advanced Integrated Visibility-Abonnement-API für Sendungsverfolgungsnummern.
So fügen Sie einem Webhook eine Sendungsverfolgungsnummer hinzu
Um Ihrem Webhook-Abonnement eine Sendungsverfolgungsnummer mithilfe der Advanced Integrated Visibility-Abonnement-API für Sendungsverfolgungsnummern hinzuzufügen, führen Sie folgende Schritte aus:
Schritt-für-Schritt-Prozess
1. Ein Abonnementprojekt anlegen
· Befolgen Sie die Schritte aus dem vorherigen Abschnitt oder verweisen Sie auf den Leitfaden für die ersten Schritte.
2. OAuth-Token generieren
- Sie benötigen ein OAuth-Token, um API-Aufrufe vorzunehmen.
- Verwenden Sie die Authorisierungs-API, um das Token zu generieren.
- Weitere Informationen finden Sie in der Dokumentation zur Authorisierungs-API im API-Katalog.
3. Zugriff auf die API-Dokumentation
- Klicken Sie im linken Navigationsmenü auf Projektdetails.
- Scrollen Sie auf der Registerkarte Produktionsschlüssel nach unten zur Dokumentation der Advanced Integrated Visibility-Abonnement-API für Sendungsverfolgungsnummern.
Ü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 der Zuordnung von Sendungsverfolgungsnummern, um Ihrem Webhook Sendungsverfolgungsnummern 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. |
Response