Quelltext der Seite FedEx Web Services auf FedEx RESTful APIs (2025)

<blockquote>''Die FedEx Web Services in ihrer Gesamtheit, einschließlich der Versanddienste, werden ab dem '''1. Juni 2026''' eingestellt. Nach der Abschaltung können die WSDLs nicht mehr verwendet werden. Alle SOAP-basierten FedEx Web Services befinden sich in der Entwicklungsbegrenzung und wurden durch die FedEx RESTful APIs ersetzt.''

</blockquote>

== Einführung ==
Um die neuen FedEx RESTful APIs nutzen zu können, werden zunächst alle Kontodaten benötigt. Die FedEx APIs unterstützen die OAuth 2.0-Authentifizierungsmethode (mit Inhaber-Token) zur Autorisierung Ihrer API-Abfragen bei FedEx Ressourcen.



== '''! Achtung !''' ==
'''Durch die Nachfolgende Konfiguration steigen Sie direkt auf die neue Fedex API um, daher sollte dies nur in Rücksprache mit dem Heidler Support gemacht werden. Da noch einige weitere Einstellungen in HVS und auch der CarrierAPI gemacht werden müssen und die Verarbeitung für ALLE Fedex Sendungen auf Fehler laufen können.'''


Der folgende Prozess darf '''nicht''' von Heidler durchgeführt werden. Er muss '''von Ihnen als Kunde selbst''' durchgeführt werden, da dabei unter anderem eine '''EULA (Nutzungsvereinbarung)''' bestätigt werden muss.

Zusätzlich wird über eine '''Multi-Faktor-Authentifizierung''' sichergestellt, dass '''Sie berechtigt sind, den FedEx-Account anzulegen'''.

== Vorraussetzung ==
Damit die FedexAPI verwendet werden kann wir eine aktuelle Version der CarrierAPI (Version 3.4.11) benötigt.

Weiter Informationen dazu finden Sie hier: [[Aktualisierung CarrierAPI]]

== OAuth2 Einrichtung ==

Um OAuth 2.0-Authentifizierungsmethode einzurichten, den Carrier API Konfigurator (HeidlerCarrierAPIConfigurator.exe) öffnen und zu Einstellungen → Web Service Account navigieren.[[Datei:Capi konfigurator webserviceaccount.png|Carrier API Konfigurator - Menu|alternativtext=|ohne|mini|238x238px]]


Wählen Sie den Auftraggeber (den Absender der Sendung) aus, der diesen Account verwenden soll, um über die FedEx REST API zuzugreifen.
[[Datei:Ag fedexws.png|ohne|mini|Carrier API Konfigurator - Frachtführer Account]]


Um den angezeigten Datensatz zu bearbeiten, wählen Sie ihn bitte aus und klicken Sie auf den Button „Editieren“ oder doppelklicken Sie einfach auf den Datensatz. Im angezeigten Fenster bitte zunächst „OAuth2 - API-Anmeldeinformationen“ auswählen (siehe 1 im Bild unten).  
[[Datei:Fedex OAuth Select.png|ohne|mini|527x527px|FedEx Account - OAuth2]]



Es gibt zwei Varianten, wie Sie sich als Heidler-Kunde mit der neuen FedEx API authentifizieren können: 
# Sie verwenden Ihren eigenen FedEx-Account, aber die API Client-ID und das API-Client-Secret von Heidler als FedEx Integrator (Parent Credentials) sowie einen über Heidler registrierten Child Key und Child Secret (Child Credentials) für Ihren FedEx-Account.
#* In diesem Fall (für die Parent Credentials) wenden Sie sich bitte an unser Support-Team, um die Heidler FedEx Integrator Account API-Client-ID und das Client-Secret einzugeben.
#* Falls Sie bereits Child Credentials besitzen, geben Sie die Werte bitte in die Felder „Child Key“ und „Child Secret“ ein. Wenn Sie noch keine Child Credentials haben, folgen Sie bitte den Anweisungen im Abschnitt [[FedEx Web Services auf FedEx RESTful APIs (2025)#Child Credentials Registrierung|Child Credentials Registrierung]].
# Sie verwenden Ihren eigenen FedEx-Account mit einer eigenen API Client-ID und einem eigenen Client-Secret (Parent Credentials)
#* In diesem Fall (für die Parent Credentials) wenden Sie sich bitte an unser Support-Team, um Ihre Account API Client-ID und das Client-Secret für die Parent Credentials einzugeben.

==Child Credentials Registrierung==
Um Child Credentials zu registrieren, benötigen Sie einen gültigen FedEx Account sowie die FedEx Integrator API Client-ID und das Client Secret (Parent Credentials) von Heidler.

Bitte navigieren Sie wie beschrieben in der [[FedEx Web Services auf FedEx RESTful APIs (2025)#OAuth2 Einrichtung|OAuth2 Einrichtung]] zu den FedEx Frachtführer Account-Einstellungen. Klicken Sie auf den Button „Registrieren“. Blättern Sie die FedEx EULA (Endbenutzer-Lizenzvereinbarung) mit Hilfe des „Nächste Seite“-Buttons durch (siehe 1 im Bild unten), bis der Button ausgegraut ist und Sie auf der letzten Seite angekommen sind. Der Button „Ich akzeptiere“ wird aktiviert, sobald Sie die Lesebestätigungs-Checkbox („Ich habe die Bedingungen des FedEx-Endbenutzer-Lizenzvertrags (EULA) gelesen“) angehakt haben (siehe 2 im Bild unten). Klicken Sie auf den Button „Ich akzeptiere“ (siehe 3 im Bild unten), um den Registrierungsprozess zu starten.
[[Datei:EULA FedEx.png|ohne|mini|655x655px|FedEx EULA Agreement]]

=== Adresspruefung ===
Als ersten Schritt wird die Rechnungsadresse Ihres FedEx-Accounts geprüft. Wählen Sie dafür zunächst die Umgebung aus (siehe 1 im Bild unten), für die Ihr FedEx-Account angelegt ist, z. B. PROD oder TEST. Anschließend tragen Sie Ihre Rechnungsadresse unter „Kundeninformationen“ ein. Klicken Sie danach auf den Button „OK“ (siehe 2 im Bild unten).
[[Datei:Fedex address validation.png|ohne|mini|455x455px|FedEx Account - Adressprüfung]]

=== Multi-Faktor-Authentifizierung ===
Anschließend folgt ein MFA-Schritt (Multi-Faktor-Authentifizierung), bei dem Sie sich über eine der folgenden Möglichkeiten authentifizieren können, um anschließend die Child Credentials zu erhalten:

# '''Validierung per Rechnung:'''
#* Bitte geben Sie die Details einer Rechnung an, um Ihre Identität zu verifizieren und die Registrierung abzuschließen. Wählen Sie dafür den Radio-Button „RECHNUNG“ aus (siehe 1 im Bild unten).[[Datei:Fedex rechnungsnummer mfa.png|ohne|mini|FedEx Account - Validierung per Rechnung]]Die wichtigsten Eingabeinformationen, die dieser Abfrage zugeordnet sind:
#** Rechnungsnummer
#** Rechnungsdatum
#** Rechnungsbetrag
#** Währung 
#*''Hinweis:''
#**''Die Rechnung darf maximal 90 Tage alt sein.''
#**''Der Rechnungsbetrag darf kein Komma als Dezimaltrennzeichen enthalten. Bitte geben Sie Beträge wie folgt an: 222.50.''
#**''Die Validierung per Rechnung schlägt fehl, wenn Sie für Rechnungsdatum, Rechnungsnummer, Betrag oder Währung einen falschen Wert angeben.''
#**''Bei mehreren fehlgeschlagenen Validierungsversuchen wird dieses Validierungsverfahren für Ihr Kundenkonto für 24 Stunden gesperrt und Sie werden aufgefordert, ein anderes Validierungsverfahren zu nutzen, z. B. die Kontaktaufnahme mit dem technischen Support von FedEx Express.''
#*Wenn alle Daten korrekt sind, senden Sie die Anfrage bitte durch einen Klick auf den Button „Übernehmen“ (siehe 2 im Bild oben).
# '''Validierung per PIN:'''
#* Als alternative Methode zur Authentifizierung der Kundennummer können Sie einen sechsstelligen Sicherheits-Code / eine sechsstellige PIN per Radio-Button ''SMS'', ''E-Mail'' oder ''Anruf'' anfordern (siehe 1 im Bild unten). Um eine sechsstellige PIN zu generieren, klicken Sie auf den Button „PIN generieren“ (siehe 2 im Bild unten).[[Datei:Fedex pin validierung.png|ohne|mini|FedEx Account - Validierung per PIN]]
#*''Hinweis:''
#**''Die generierte PIN ist 10 Minuten lang gültig.''
#**''Bei mehreren fehlgeschlagenen Validierungsversuchen wird dieses Validierungsverfahren für Ihr Kundenkonto für 24 Stunden gesperrt und Sie werden aufgefordert, ein anderes Validierungsverfahren zu nutzen, z. B. die Kontaktaufnahme mit dem technischen Support von FedEx Express.''
#* Als erfolgreiche Antwort auf diese Anfrage wird ein sechsstelliger Sicherheitscode/eine sechsstellige PIN generiert, der bzw. die über das ausgewählte Zustellverfahren (SMS, Anruf oder E-Mail) an die für die FedEx Kundennummer registrierte Telefonnummer oder E-Mail-Adresse gesendet wird.
#* Wenn die Telefonnummer oder E-Mail-Adresse in Ihrem FedEx Kundenkonto nicht gefunden wird, werden Sie aufgefordert, ein anderes verfügbares Validierungsverfahren zu nutzen.
# '''Validierung per Kontaktaufnahme mit dem technischen Support von FedEx Express:'''
#* Sie können sich außerdem per Telefon an den technischen Support von FedEx Express wenden, wenn Sie Ihr FedEx Kundenkonto online nicht validieren können. Zur Validierung Ihrer Identität und zur Autorisierung Ihres Zugriffs benötigt der technische Support von FedEx Express bestimmte Informationen. Nach erfolgreich abgeschlossener Validierung erhalten Sie durch den technischen Support von FedEx Express eine Backend-Authentifizierung. Nachdem Sie diese Backend-Authentifizierung erhalten haben, müssen Sie nur noch den Schritt „[[FedEx Web Services auf FedEx RESTful APIs (2025)#Adresspruefung|Adressprüfung]]“ durchführen, damit die Child Credentials generiert werden und Sie die Kundenregistrierung abschließen können.
Zum Schluss sollten die Child Credentials generiert und in den FedEx-Account-Einstellungen des Konfigurators eingetragen sein. Bitte klicken Sie dafür auf den Button „OK“ (siehe Bild unten).
[[Datei:Filled client credentials.png|ohne|mini|526x526px|FedEx Account - mit Child Credentials]]
Bestätigen Sie auch weiterhin das Fenster „Frachtführer Account Einstellungen“ mit „OK“ und klicken Sie zum Schluss auf „Datei -> Speichern“.
[[Datei:Save-capi konfig.png|ohne|mini|Carrier API Konfig speichern]]
Nach dem erfolgreichen Speichern sollte eine Meldung wie im unten stehenden Bild erscheinen.
[[Datei:Capi success save.png|ohne|mini|Carrier API Konfig erfolgreich gespeichert]]
#