Los geht's
Das FedEx Developer Portal bietet eine Reihe von Programmierschnittstellen (Application Programming Interfaces, APIs), um FedEx in Ihre Anwendungen zu integrieren. In dieser Anleitung finden Sie Informationen zur Einrichtung einer Organisation, zum Erstellen eines Projekts, zum Testen Ihrer Integration, zum Verschieben eines Projekts in die Produktion und zur Validierung Ihrer API, falls erforderlich.
Benutzertypen:
FedEx bietet Integrationsservices für drei Benutzertypen an: FedEx Versender, FedEx Compatible Providers (Anbieter verifizierter Softwarelösungen) und FedEx Integrator Providers (Anbieter validierter Integrationslösungen).
FedEx Versender:
Ein Unternehmen, das mit FedEx versendet und FedEx APIs in seine Anwendungen integrieren muss.
Lösungsanbieter oder Dienstleister:
Ein Unternehmen, das FedEx APIs bei der Entwicklung einer Lösung, einer Anwendung oder eines Plug-ins integrieren muss, um diese(s) an eine externe Organisation zu verkaufen und/oder bereitzustellen, die mit FedEx versendet.
- FedEx Compatible Provider: Ein verifiziertes Unternehmen mit einer vertraglichen Vereinbarung im Rahmen des FedEx Compatible-Programms.
- FedEx Integrator Provider: Ein validiertes Unternehmen mit einer vertraglichen Vereinbarung im Rahmen des FedEx Integrator-Programms.
Wählen Sie unten die Option aus, die Ihr Unternehmen am besten beschreibt. Für jeden Benutzertyp gibt es die passende Einführung.
Wählen Sie zunächst eine Option aus.
Which of the following best describes your business?
Select user
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company validated by the FedEx Compatible program who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
- FedEx Integrator Provider: Validated company with a contractual agreement through the FedEx Integrator Program.
Grundvoraussetzung
Sie müssen über eine FedEx-Benutzer-ID verfügen, um sich im FedEx Developer Portal anzumelden und eine Organisation zu erstellen.
Falls Ihr Unternehmen keine Organisation hat, erstellen Sie eine. Treten Sie ansonsten einer vorhandenen Organisation bei.
Erstellen einer neuen Organisation
Klicken Sie in der Navigationsleiste auf „Organisation erstellen oder Organisation beitreten“.
Hinweis: Als Ersteller*in werden Sie automatisch als Administrator*in der Organisation festgelegt.
Administrator*innen können:
Benutzer*innen zum Beitritt einladen
Benutzer*innen Rollen (z. B. Contributor, Viewer) und Projekte zuweisen
Versandkonten verwalten
In unserer Anleitung zur Administration von Organisationen erfahren Sie mehr über diese Rollen.
Wählen Sie als Art des Unternehmens „Verkauft oder stellt eine Softwarelösung bereit, die FedEx Technologie verwendet und ein validierter FedEx Integrator Provider ist“ aus.
Geben Sie den Namen Ihres Unternehmens, die URL der Unternehmenswebsite und einen eindeutigen Organisationsnamen an. Der Organisationsname kann mit dem Unternehmensnamen identisch sein oder für eine spezifische Gruppe (z. B. Abteilung, Geschäftsbereich, Region, Standort) in Ihrem Unternehmen stehen. Diese Angabe wird zur Validierung Ihrer Anfrage benötigt.
Hinweis: Wählen Sie einen Organisationsnamen aus, den alle anderen Benutzer wiedererkennen (z. B. Name Ihres Unternehmens, Abteilung, Region, Standort).
Geben Sie den Standort Ihres Unternehmens und die Länder/Gebiete an, in denen Ihre Softwarelösung verkauft oder bereitgestellt wird.
Fügen Sie ein Abrechnungskonto hinzu und authentifizieren sie das Konto.
Hinweis: Als Versand- und Logistikanbieter im FedEx Integrator Program müssen Sie Ihre eigene Kundennummer verwenden. Sie dürfen kein FedEx Kundenkonto verwenden.
Geben Sie Ihre FedEx Kundennummer ein. Falls Sie kein bestehendes FedEx Kundenkonto haben, eröffnen Sie eines auf fedex.com oder kontaktieren Sie einen FedEx Kundendienstvertreter.
Geben Sie einen Spitznamen für Ihr Kundenkonto und die mit dem Kundenkonto verbundene Rechnungsadresse ein. Wählen Sie „Weiter“ aus.
Hinweis: Die Rechnungsadresse muss mit unseren Aufzeichnungen für dieses Kundenkonto übereinstimmen. Dieses Konto wird das Standardabrechnungskonto für Ihre Organisation sein.
Um die Erstellung Ihrer Organisation abzuschließen, müssen Sie Ihr Kundenkonto authentifizieren. Wählen Sie eine Authentifizierungsoption (Telefon [nur für Integrator in den USA und Kanada verfügbar], E-Mail, SMS) und klicken Sie dann auf „Weiter“.
Geben Sie den Authentifizierungscode ein, sobald Sie ihn erhalten, und wählen Sie „Absenden“ aus.
Nutzungsbedingungen akzeptieren
Lesen Sie sich die Globale Integrator-Vereinbarung und das Programmhandbuch durch. Setzen Sie Häkchen in den entsprechenden Kontrollkästchen, um zu bestätigen, dass Sie die Bedingungen akzeptieren. Wählen Sie dann „Akzeptieren“.
Ein Bestätigungsbildschirm erscheint. Klicken Sie auf „Organisation verwalten“, um bei Bedarf Angaben zu bearbeiten.
Benutzer einladen
Hinweis: Nur Admins können Benutzer*innen einladen.
Wählen Sie im linken Navigationsbereich „Organisation verwalten“ aus.
Gehen Sie zur Registerkarte „Benutzer“ und wählen Sie „Benutzer hinzufügen“.
Füllen Sie das Formular aus und weisen Sie die entsprechende Rolle dem/den neuen Benutzer(n) zu: Viewer, Contributor oder Admin.
Weitere Informationen zu Benutzerrollen finden Sie in unserer Anleitung zur Administration von Organisationen.
Weisen Sie Benutzer*innen im Dropdown-Menü „Projekte“ Projekte zu (falls zutreffend).
Geben Sie die E-Mail-Adressen der einzelnen Benutzer*innen ein und wählen Sie dann „Einladen“.
Einer vorhandenen Organisation beitreten
Einladung anfordern: Bitten Sie den*die Administrator*in Ihrer Organisation, Ihnen eine Einladung zu senden. Sie haben 24 Stunden Zeit, um die Einladung anzunehmen, bevor sie abläuft. Bitten Sie den*die Administrator*in bei Bedarf, die Einladung erneut zu senden.
Einladung annehmen: Melden Sie sich mit Ihrer vorhandenen Benutzer-ID und Ihrem Passwort an. Wenn Ihre ID bereits einer anderen Organisation zugeordnet ist, müssen Sie eine neue erstellen.
Einer vorhandenen Organisation beitreten
Schritt 1: Den Admin Ihrer Organisation eine Einladung bitten
Wenn Ihr Unternehmen bereits eine Organisation erstellt hat, bitten Sie den*die Administrator*in um eine Einladung. Sie haben 24 Stunden Zeit, eine Einladung anzunehmen. Wenn dieses Zeitfenster verstreicht, müssen Sie den*die Administrator*in erneut um eine Einladung bitten.
Schritt 2: Einladung annehmen
Um die Einladung anzunehmen, müssen Sie sich entweder mit Ihrer vorhandenen Benutzer-ID und Ihrem Passwort anmelden oder eine neue Benutzer-ID erstellen, sofern Ihre Benutzer-ID bereits einer Organisation zugeordnet ist.
API-Projekt erstellen
Rufen Sie auf der Seite Meine Projekte die Registerkarte APIs auf. Klicken Sie auf API-Projekt erstellen.
Schritt 1: Die API(s) auswählen, die Sie in Ihrem Projekt nutzen möchten
Überprüfen Sie die API-Kontingente, Ratenbegrenzungen und Details zur API-Validierung.
Schritt 2: Projektdetails konfigurieren
- Geben Sie Ihrem Projekt einen aussagekräftigen Namen, der für Ihre Organisation eindeutig ist.
- Wählen Sie alle Länder aus, innerhalb derer Sie versenden möchten, damit wir Ihnen ein Testversandkonto zuweisen können. Um Pakete für den nationalen Versand innerhalb eines europäischen Landes zu testen, benötigen Sie für jedes Land ein eigenes Testkonto. Sie können Länder zu einem späteren Zeitpunkt jederzeit hinzufügen/entfernen.
- Wenn Sie Benachrichtigungen zu API-Updates und Serviceausfällen erhalten möchten, können Sie dies in den Benachrichtigungseinstellungen festlegen.
Schritt 3: Nutzungsbedingungen lesen und akzeptieren, einschließlich der Lizenzvereinbarung für das FedEx Developer Portal
Wenn Sie nach Akzeptieren der Bedingungen auf „Erstellen“ klicken, wird ein Bestätigungsfenster angezeigt. Sie können nun innerhalb Ihres neuen Projekts Ihre Testzugangsdaten einsehen.
Ein Webhook-Projekt erstellen
Grundvoraussetzungen
- Preisgestaltung überprüfen: Abonnenten zahlen eine monatliche Gebühr basierend auf der Anzahl der Sendungsverfolgungsnummern. Siehe den Pricing Guide, um mehr über die Preisgestaltung zu erfahren.
- Kundenkontos einrichten: Advanced Integrated Visibility Webhook erfordert ein abrechnungsfähiges Konto mit Sitz in den USA sowie mindestens ein Versandkonto. Diese beiden Kontotypen schließen sich gegenseitig aus. Nur Administratoren können auf der Seite Organisation verwalten Abrechnungs- und Versandkonten hinzufügen.
Eine gültige (Rückruf-)URL in der Zielanwendung oder -plattform erstellen
Ihre Ziel-URL dient zum Empfang von Authentifizierungscodes und Mitteilungen sowie von Benachrichtigungen zum Webhook-Payload von FedEx. Aus Sicherheitsgründen muss Ihre URL HTTPS nutzen. Ihre URL wird blockiert, wenn Folgendes enthalten ist:
- RFC1918-IP-Bereich
- fedex.com oder Subdomains
- IP-Adressen in der URL (einschließlich localhost, 127.0.0.1)
Ein Sicherheitstoken erstellen
Dieses Sicherheitstoken kann als geheimer Schlüssel zur Authentifizierung und Validierung der zwischen Ihrer Organisation und FedEx übermittelten Informationen verwendet werden. Ihr Sicherheitstoken muss folgende Anforderungen erfüllen:
- Länge von min. 26 und max. 100 Zeichen
- 1 Großbuchstabe
- 1 Kleinbuchstabe
- 1 numerisches Zeichen
Beispiel: Y1F6OiVUQW2JPSElmRE9U0IY5
Nachdem Sie Ihre URL und Ihr Sicherheitstoken erstellt haben, können Sie ein Webhook-Projekt anlegen. Rufen Sie auf der Seite Meine Projekte die Registerkarte Webhooks auf. Klicken Sie auf Ein Webhook-Projekt erstellen.
Abonnementtyp wählen
FedEx Versender können Ereignisse über Kundennummern oder Sendungsverfolgungsnummern abonnieren.
Schritt 1: Abrechnungskonto bestätigen und Funktionen wählen
- Überprüfen Sie das aufgeführte Standardabrechnungskonto, um es zu bestätigen oder ein anderes Konto für Ihre Organisation auszuwählen.
- Konfigurieren Sie Ihr Projekt, indem Sie Funktionen wie Zustellnachweisoptionen, Optionen für die voraussichtliche Zustellung, Sendungsverfolgungsereignisse und ereignisbasierte Filterung auswählen.
Schritt 2: Projektdetails eingeben
- Geben Sie Ihrem Projekt einen aussagekräftigen Namen, der für Ihre Organisation eindeutig ist.
- Geben Sie Ihre Ziel-URL und das Sicherheitstoken ein, die im Zuge der Authentifizierung vor der Einrichtung erstellt wurden (siehe oben).
- Wenn Sie Benachrichtigungen zu Webhook-Updates und Serviceausfällen erhalten möchten, geben Sie eine E-Mail-Adresse und Ihre bevorzugte Sprache an.
Schritt 3: Bedingungen lesen und akzeptieren
Wenn Sie nach Akzeptieren der Bedingungen (einschließlich der Lizenzvereinbarung für das FedEx Developer Portal und des Auftragsformulars) auf „Erstellen“ klicken, wird ein Bestätigungsfenster angezeigt.
Je nach gewähltem Abonnementtyp können weitere Schritte erforderlich sein. Weitere Informationen finden Sie in der Dokumentation.
Rufen Sie Ihre Testzugangsdaten (API-Schlüssel, geheimer Schlüssel und Versandkonten) auf der Seite API-Projektübersicht über die Registerkarte Testschlüssel ab.
Schritt 1: OAuth-Zugriffstoken anfordern
Das OAuth-Zugriffstoken muss bei jeder API-Transaktion verwendet werden. Das Token ist nur eine Stunde lang gültig. Sie müssen Ihre Anwendung so codieren, dass das Token vor Ablauf der Sitzung aktualisiert wird. Weitere Einzelheiten finden Sie in der Dokumentation zur API Authorization.
Schritt 2: API-Dokumentation lesen
Klicken Sie auf die jeweilige Dokumentation für Ihre APIs, um sich über den geschäftlichen Kontext und die richtige Verwendung der API zu informieren. Melden Sie sich an, um über die Schaltfläche oben auf der Dokumentationsseite die JSON API-Sammlung herunterzuladen. Sie können auch Beispielanfragen für Endpunkte prüfen, die Ihrer gewünschten Integration entsprechen.
Schritt 3: Beispieltransaktionen in der Sandbox testen
Klicken Sie im linken Navigationsmenü den gewünschten Endpunkt an, um zur jeweiligen Sandbox zu gelangen. Suchen Sie nach den Beispielanfragen, die Ihrem Anwendungsfall entsprechen. Verwenden Sie dann Ihre Testzugangsdaten und die FedEx Test-URLs, um Ihre Aufrufe an den Endpunkt wie bei den Beispielanfragen beschrieben zu implementieren. Vergewissern Sie sich, dass die API-Aufrufantworten, die Sie empfangen, mit den in der Dokumentation angegebenen übereinstimmen. Weitere Informationen zu diesen Tests finden Sie in der Anleitung zur API-Sandboxvirtualisierung.
Tests mit Webhooks
Sie können durch die Tests herausfinden, ob Ihre erstellte URL gültig ist. FedEx kann Ihre URL dabei identifizieren und eine Verbindung zu Ihrer URL herstellen, um den Datentransfer zu ermöglichen. Sie erhalten außerdem Beispieltestdaten, mit denen Sie prüfen und bestätigen können, ob Sie die Sendungsverfolgungsdaten, die in Ihrer Anwendung bereitgestellt werden, verarbeiten können. Durch das Testen wird Ihre URL jedoch nicht authentifiziert. In unserer Webhook-Dokumentation erfahren Sie, wie Sie Ihre Webhook-URL testen.
Rufen Sie in der Projektübersicht die Registerkarte Produktionsschlüssel auf. Projekte mit Kundennummer-basiertem Advanced Integrated Visibility-Abonnement müssen nicht in die Produktion verschoben werden.
Schritt 1: Projekt konfigurieren
- Benennen Sie Ihren Schlüssel bei Bedarf um.
- Prüfen Sie die Kundennummer, die Sie in Schritt 1 während der Projekterstellung ausgewählt haben. Diese wird verwendet, um Ihr Projekt in die Produktion zu verschieben. Sobald Ihr Projekt freigeschaltet ist, können Sie bei Bedarf weitere Kundenkonten hinzufügen.
Schritt 2: Projektschlüssel abrufen
Kopieren Sie Ihren API-Produktionsschlüssel und geheimen Produktionsschlüssel und speichern Sie diese an einem sicheren Ort. Aus Sicherheitsgründen wird Ihr geheimer Produktionsschlüssel nur einmal angezeigt. Wenn Sie ihn verlieren, können Sie einen neuen erstellen.
Wenn Sie nach dem Abruf der Projektschlüssel auf Weiter klicken, sehen Sie Ihre Projektdetails auf der Registerkarte Produktionsschlüssel.
- Klicken Sie oben in der Tabelle mit den Versandkonten auf Bearbeiten, um weitere Versandkonten hinzuzufügen.
Die Validierungsschritte unterscheiden sich je nach Region
Die folgenden Schritte gelten nur für Kunden in den USA und Kanada. Wenn Sie außerhalb dieser Länder leben, besuchen Sie die Seite API-Validierung, um Unterstützung zu erhalten.
Einige APIs erfordern eine Versandetikettenvalidierung zur Verwendung in unserer Produktionsumgebung. Hier können Sie nachsehen, ob Ihre API eine Validierung erfordert.
Schritt 1: Entwickeln und Testen von FedEx APIs mit Ihrer Webanwendung
Nach Abschluss der Entwicklung Ihrer Webanwendung ist es Zeit für die Tests mithilfe der Testzugangsdaten (Testversandkonto/Testversandkonten, API-Schlüssel und geheimer Schlüssel). Der API-Schlüssel und der geheime Schlüssel für den Test werden auf der Projektübersichtsseite angezeigt und können jederzeit aufgerufen werden.
Schritt 2: Verschieben des Projekts in die Produktion
Nachdem Sie die Tests mit den FedEx APIs durchgeführt haben, leiten Sie das Validierungsverfahren ein, indem Sie Ihr Projekt im FedEx Developer Portal in die Produktion verschieben. Danach werden Ihr API-Schlüssel und Ihr geheimer Schlüssel für die Produktion angezeigt. Der geheime Schlüssel für die Produktion wird Ihnen nur einmal angezeigt, kann jedoch zu einem späteren Zeitpunkt neu erstellt werden.
Schritt 3: Ausfüllen des Etikettendeckblatts
Füllen Sie das Etikettendeckblatt vollständig aus. Geben Sie dabei Ihre Kontaktdaten sowie die Services an, die Sie implementieren möchten. Geben Sie auch Ihre Kundennummer und Ihren Produktionsschlüssel an.
Schritt 4: Testetiketten generieren und an Barcodeanalysegruppe senden
Generieren Sie Testetiketten innerhalb der FedEx Testumgebung für die Anwendung und reichen Sie die Testetiketten beim FedEx Etikettenprüfungsteam zur Genehmigung ein. Die Barcodeanalysegruppe benötigt drei Werktage, um Etiketten zu prüfen.
Beachten Sie diese Best Practices, um Verzögerungen bei der Bearbeitung zu vermeiden:
- Etiketten müssen mit mindestens 600 DPI gedruckt und gescannt werden. REICHEN SIE KEINE VON DEN APIs GENERIERTEN DATEIEN EIN.
- Für Thermodrucker muss der Etikettentyp passend zum Druckermodell angefordert werden. Beispiel: ZPLII für Zebra Drucker
- Verwenden Sie beim Erstellen der Musteretiketten für die Prüfung die Angaben zu Absender/Empfänger. Erstellen Sie Musteretiketten nur für die jeweils verwendeten Services, die beantragt wurden.
- FedEx® Nachnahme-Etiketten müssen auch das entsprechende Nachnahme-Rücksendeetikett enthalten.
- FedEx International Express® Sendungen müssen das zusätzliche/sekundäre Luftfrachtbriefetikett (AWB) enthalten.
- Mehrpaketsendungen (MPS) müssen ein Etikett für jedes Paket in der Sendung enthalten.
- Senden Sie das PDF und das Etikettendeckblatt per E-Mail an label@fedex.com.
- Physische Etiketten können per Post an folgende Anschrift gesendet werden:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Wenn die gescannten Etiketten keine sichtbaren Fehler aufweisen (z. B. Linien im Barcode, Tintenflecken oder physische Beschädigungen), bestehen diese voraussichtlich die Inspektion und werden genehmigt.
Achten Sie bei der Einreichung physischer Etiketten auf die Druckqualität und versehentliche Vergrößerungen/Verkleinerungen (d. h. Skalierung). Dies sind die beiden häufigsten Ursachen dafür, dass Etiketten die Prüfung nicht bestehen.
Schritt 5: Etiketten prüfen
Die Barcodeanalysegruppe prüft die eingereichten Testetiketten und genehmigt diese oder lehnt sie ab. Die Barcodeanalysegruppe informiert Sie über die Genehmigung oder Ablehnung der eingereichten Etiketten. Fahren Sie mit dem nächsten Schritt fort, wenn die Etiketten genehmigt wurden. Wenn die Etiketten abgelehnt wurden, korrigieren Sie die Etiketten wie angegeben und reichen Sie sie erneut zur Genehmigung ein.
Schritt 6: Anwendung aktivieren
Nachdem die Barcodeanalysegruppe die Genehmigung zur Übernahme der Testetiketten in den Produktionsstatus erteilt hat, erhalten Sie Ihre Produktionszugangsdaten zur Übertragung der angegebenen Versandetikettentransaktion und werden per E-Mail über die erfolgreiche Validierung informiert. Genehmigungen werden auf Projektbasis erteilt.
Schritt 7: Ersetzen von URL und Zugangsdaten
Ersetzen Sie die URL und die Zugangsdaten für den Test durch die URL und die Zugangsdaten für die Produktion. Testen Sie Ihre Implementierung in der Produktionsumgebung erneut mithilfe von Beispieldaten.
Grundvoraussetzung
Ihr Unternehmen muss ein bereits existierender FedEx Compatible Provider sein. Wenn Ihr Unternehmen nicht Teil des Compatible Program ist, ändern Sie bitte oben Ihre Auswahl auf „Non-Compatible Provider“.
Schritt 1: Einladung zum Beitritt zur Organisation erhalten
FedEx erstellt eine Organisation und sendet dann eine Einladung an ein Teammitglied. Diese*r Benutzer*in ist der*die Administrator*in Ihrer Organisation.
Schritt 2: Einladung annehmen
Um die Einladung anzunehmen, müssen Sie sich entweder mit Ihrer vorhandenen Benutzer-ID und Ihrem Passwort anmelden oder eine neue Benutzer-ID erstellen, sofern Ihre Benutzer-ID bereits einer Organisation zugeordnet ist.
Schritt 3: Benutzer*innen einladen
Admins können Benutzer*innen in die eigene Organisation einladen und ihnen Rollen und Projekte zuweisen. Öffnen Sie die Registerkarte „Benutzer*innen“. Klicken Sie auf „Benutzer*innen hinzufügen“.
- Wählen Sie eine Benutzerrolle: Viewer, Contributor oder Admin. Weitere Informationen zu diesen Rollen finden Sie in unserer Anleitung zur Administration von Organisationen.
- Wenn bereits Projekte vorhanden sind, weisen Sie dem/der Benutzer*in ein Projekt zu. Sie können auch in jeder beliebigen Projektübersicht Benutzer*innen Projekten zuweisen.
- Geben Sie die E-Mail-Adressen der Benutzer*innen ein, die Sie mit der ausgewählten Rolle zu Ihrer Organisation hinzufügen möchten.
Rufen Sie den API-Katalog auf, um die richtigen APIs oder Webhooks für Ihre Lösung zu bestimmen. Ihr*e FedEx Customer Technology Consultant (CTC) und Compatible Channel Manager*in helfen Ihnen gern bei der Auswahl der richtigen APIs für Ihre Lösung und Ihre Anforderungen.
Schritt 1: PIW ausfüllen
Kehren Sie zur Compatible Provider Community (CPC) zurück, um das Product Information Worksheet (PIW) auszufüllen.
Schritt 2: Von FedEx erstellte(s) Projekt(e) prüfen
Nach der Genehmigung des PIW erstellt FedEx Ihr(e) Projekt(e). Jede Version Ihrer jeweiligen Lösung wird als eigenes Projekt im FedEx Developer Portal gespeichert.
Schritt 3: Mit Ihrem Team an API-Demo teilnehmen
Das FedEx Compatible Team sowie die FedEx CTC- und Verifizierungsteams geben Ihrem Team eine technische Demonstration der APIs. Das FedEx Team geht dabei auf die Verifizierung für das Compatible-Programm sowie neue API-Funktionen und Features ein und beantwortet Ihre Fragen.
Rufen Sie Ihre Testzugangsdaten (API-Schlüssel und geheimer Schlüssel) auf der Seite API-Projektübersicht über die Registerkarte Testschlüssel ab.
Schritt 1: Kundenschlüssel erstellen
Erstellen Sie Kundenschlüssel mithilfe der API für die Registrierung von Zugangsdaten. Dies ist eine private API, die Sie nur im API-Bereich unten auf der Seite mit der API-Projektübersicht finden.
Schritt 2: OAuth-Zugriffstoken anfordern
Das OAuth-Zugriffstoken muss bei jeder API-Transaktion verwendet werden. Das Token ist nur eine Stunde lang gültig. Sie müssen Ihre Anwendung so codieren, dass das Token vor Ablauf der Sitzung aktualisiert wird. Weitere Einzelheiten finden Sie in der Dokumentation zur API Authorization. Achten Sie bei der Anzeige von Beispielcode darauf, dass in der Drop-down-Liste mit Beispielen „Reseller“ ausgewählt ist.
Schritt 3: API-Dokumentation lesen
Klicken Sie auf die jeweilige Dokumentation für Ihre APIs, um sich über den geschäftlichen Kontext und die richtige Verwendung der API zu informieren. Melden Sie sich an, um über die Schaltfläche oben auf der Dokumentationsseite die JSON API-Sammlung herunterzuladen. Sie können auch Beispielanfragen für Endpunkte prüfen, die Ihrer gewünschten Integration entsprechen.
Schritt 4: Beispieltransaktionen in der Sandbox testen
Klicken Sie im linken Navigationsmenü den gewünschten Endpunkt an, um zur jeweiligen Sandbox zu gelangen. Suchen Sie nach den Beispielanfragen, die Ihrem Anwendungsfall entsprechen. Verwenden Sie dann Ihre Testzugangsdaten und die FedEx Test-URLs, um Ihre Aufrufe an den Endpunkt wie bei den Beispielanfragen beschrieben zu implementieren. Vergewissern Sie sich, dass die API-Aufrufantworten, die Sie empfangen, mit den in der Dokumentation angegebenen übereinstimmen. Weitere Informationen zu diesen Tests finden Sie in der Anleitung zur API-Sandboxvirtualisierung.
Schritt 5: Lösungen verifizieren lassen
Nachdem Sie Ihre Lösungen ausführlich getestet haben, können Sie die Testfälle zur Prüfung der einzelnen Lösungen an das Verifizierungsteam übermitteln. FedEx prüft alle übermittelten Inhalte und informiert Sie, sobald Ihre Verifizierung genehmigt wurde.
Tests mit Webhooks
Wenn Ihre Organisation Zugang zu Webhooks hat, können Sie mithilfe von Tests feststellen, ob Ihre erstellte URL gültig ist. FedEx kann Ihre URL dabei identifizieren und eine Verbindung zu Ihrer URL herstellen, um den Datentransfer zu ermöglichen. Sie erhalten außerdem Beispieltestdaten, mit denen Sie prüfen und bestätigen können, ob Sie die Sendungsverfolgungsdaten, die in Ihrer Anwendung bereitgestellt werden, verarbeiten können. Durch das Testen wird Ihre URL jedoch nicht authentifiziert. In unserer Webhook-Dokumentation erfahren Sie, wie Sie Ihre Webhook-URL testen.
FedEx verschiebt Ihr(e) Projekt(e) dann in die Produktion. Rufen Sie in der API-Projektübersicht die Registerkarte Produktionsschlüssel auf. Klicken Sie in der Spalte Geheimer Schlüssel auf den Link Geheimen Schlüssel generieren.
Sie können Ihre Implementierung jetzt in der Produktionsumgebung erneut mithilfe von Beispieldaten testen.
Grundvoraussetzung
Sie müssen über eine FedEx-Benutzer-ID und ein Kundenkonto verfügen, um sich im FedEx Developer Portal anzumelden und eine Organisation zu erstellen.
Erstellen Sie entweder eine neue Organisation, sofern noch nicht vorhanden, oder treten Sie einer bestehenden Organisation Ihres Unternehmens bei.
Eine neue Organisation erstellen
Klicken Sie in der Navigationsleiste auf „Organisation erstellen oder Organisation beitreten“.
Hinweis: Als Ersteller*in werden Sie automatisch als Administrator*in der Organisation festgelegt.
Administrator*innen können:
Benutzer*innen zum Beitritt einladen
Benutzer*innen Rollen (z. B. Contributor, Viewer) und Projekte zuweisen
Versandkonten verwalten
In unserer Anleitung zur Administration von Organisationen erfahren Sie mehr über diese Rollen.
Wählen Sie als Art des Unternehmens „Verkauft oder stellt eine Softwarelösung bereit, die FedEx Technologie verwendet und ein validierter FedEx Integrator Provider ist“ aus.
Geben Sie den Namen Ihres Unternehmens, die URL der Unternehmenswebsite und einen eindeutigen Organisationsnamen an. Der Organisationsname kann mit dem Unternehmensnamen identisch sein oder für eine spezifische Gruppe (z. B. Abteilung, Geschäftsbereich, Region, Standort) in Ihrem Unternehmen stehen. Diese Angabe wird zur Validierung Ihrer Anfrage benötigt.
Hinweis: Wählen Sie einen Organisationsnamen aus, den alle anderen Benutzer wiedererkennen (z. B. Name Ihres Unternehmens, Abteilung, Region, Standort).
Geben Sie den Standort Ihres Unternehmens und die Länder/Gebiete an, in denen Ihre Softwarelösung verkauft oder bereitgestellt wird.
Fügen Sie ein Abrechnungskonto hinzu und authentifizieren sie das Konto.
Hinweis: Als Versand- und Logistikanbieter im FedEx Integrator Program müssen Sie Ihre eigene Kundennummer verwenden. Sie dürfen kein FedEx Kundenkonto verwenden.
Geben Sie Ihre FedEx Kundennummer ein. Falls Sie kein bestehendes FedEx Kundenkonto haben, eröffnen Sie eines auf fedex.com oder kontaktieren Sie einen FedEx Kundendienstvertreter.
Geben Sie einen Spitznamen für Ihr Kundenkonto und die mit dem Kundenkonto verbundene Rechnungsadresse ein. Wählen Sie „Weiter“ aus.
Hinweis: Die Rechnungsadresse muss mit unseren Aufzeichnungen für dieses Kundenkonto übereinstimmen. Dieses Konto wird das Standardabrechnungskonto für Ihre Organisation sein.
Um die Erstellung Ihrer Organisation abzuschließen, müssen Sie Ihr Kundenkonto authentifizieren. Wählen Sie eine Authentifizierungsoption (Telefon [nur für Integrator in den USA und Kanada verfügbar], E-Mail, SMS) und klicken Sie dann auf „Weiter“.
Geben Sie den Authentifizierungscode ein, sobald Sie ihn erhalten, und wählen Sie „Absenden“ aus.
Nutzungsbedingungen akzeptieren
Lesen Sie sich die FedEx Integrator-Vereinbarung und das Programmhandbuch durch. Setzen Sie Häkchen in den entsprechenden Kontrollkästchen, um zu bestätigen, dass Sie die Bedingungen akzeptieren. Wählen Sie dann „Akzeptieren“.
Ein Bestätigungsbildschirm erscheint. Klicken Sie auf „Organisation verwalten“, um bei Bedarf Angaben zu bearbeiten.
Benutzer einladen
Hinweis: Nur Admins können Benutzer*innen einladen.
Wählen Sie im linken Navigationsbereich „Organisation verwalten“ aus.
Gehen Sie zur Registerkarte „Benutzer“ und wählen Sie „Benutzer hinzufügen“.
Füllen Sie das Formular aus und weisen Sie die entsprechende Rolle dem/den neuen Benutzer(n) zu: Viewer, Contributor oder Admin.
Weitere Informationen zu Benutzerrollen finden Sie in unserer Anleitung zur Administration von Organisationen.
Weisen Sie Benutzer*innen im Dropdown-Menü „Projekte“ Projekte zu (falls zutreffend).
Geben Sie die E-Mail-Adressen der einzelnen Benutzer*innen ein und wählen Sie dann „Einladen“.
Einer vorhandenen Organisation beitreten
Einladung anfordern: Bitten Sie den*die Administrator*in Ihrer Organisation, Ihnen eine Einladung zu senden. Sie haben 24 Stunden Zeit, um die Einladung anzunehmen, bevor sie abläuft. Bitten Sie den*die Administrator*in bei Bedarf, die Einladung erneut zu senden.
Einladung annehmen: Melden Sie sich mit Ihrer vorhandenen Benutzer-ID und Ihrem Passwort an. Wenn Ihre ID bereits einer anderen Organisation zugeordnet ist, müssen Sie eine neue erstellen.
Erstellen eines API-Projekts
Gehen Sie zu Ihrer Seite Meine Projekte und wählen Sie Projekt erstellen.
Füllen Sie das Feld Projektname aus. Das empfohlene Namensformat lautet „Projectname_applicationname“. Wählen Sie Weiter aus, wenn Sie fertig sind.
Wählen Sie die API und Advanced Integrated Visibility-Produkte für Ihr Projekt aus.
Hinweis: Advanced Integrated Visibility-Produkte sind nur für US-amerikanische FedEx Integrator Providers verfügbar.
Hinweis: Wenn Sie kostenpflichtige Produkte auswählen, werden Sie aufgefordert, dem Projekt ein Abrechnungskonto zuzuweisen und die erforderlichen Bedingungen zu akzeptieren.
Zuweisen der Rechnung und Akzeptieren der Nutzungsbedingungen
Weisen Sie ein Abrechnungskonto aus der Liste der zur Organisation hinzugefügten Kundenkonten zu. Dieser Schritt ist nur erforderlich, wenn Sie zuvor ein kostenpflichtiges Produkt ausgewählt haben.
Akzeptieren Sie die mit dem Produkt verbundenen Allgemeinen Geschäftsbedingungen.
Bestätigen der Angaben
Überprüfen Sie die ausgewählten Produkte. Verifizieren Sie das bereitgestellte Abrechnungskonto.
Prüfen und akzeptieren Sie die FedEx Developer Portal-Lizenzvereinbarung.
Klicken Sie auf Erstellen, um Ihr Projekt zu generieren und die Testzugangsdaten anzuzeigen.
Konfigurieren von Advanced Integrated Visibility in einem Projekt
Grundvoraussetzungen
Grundvoraussetzungen
- Preisgestaltung überprüfen: Abonnenten zahlen eine monatliche Gebühr basierend auf der Anzahl der Sendungsverfolgungsnummern. Weitere Informationen über die Preisgestaltung finden Sie im Bestellformular.
- Kundenkontos einrichten: Advanced Integrated Visibility erfordert ein abrechnungsfähiges Konto mit Sitz in den USA sowie mindestens ein Versandkonto. Diese beiden Kontotypen schließen sich gegenseitig aus. Nur Administratoren können auf der Seite Organisation verwalten Abrechnungs- und Versandkonten hinzufügen.
Erstellen einer gültigen Callback-URL in Ihrer Zielanwendung oder -plattform – Ihre Anwendungs-/Plattform-URL:
muss aus Sicherheitsgründen HTTPS verwenden
darf keinen RFC1918-IP-Bereich und keine fedex.com-Subdomains oder direkten IP-Adressen (z. B. 127.0.0.1) enthalten
Erstellen eines Sicherheitstokens
Muss 26–100 Zeichen lang sein und mindestens folgende Zeichen enthalten:
- 1 Großbuchstaben
- 1 Kleinbuchstaben
- 1 Ziffer
Beispiel: Y1F6OiVUQW2JPSElmRE9U0IY5
Konfigurieren von Advanced Integrated Visibility
Wählen Sie Advanced Integrated Visibility aus. Wählen Sie Funktionen wie Zustellnachweis, voraussichtliche Zustellung, Tracking-Ereignisse und ereignisbasierte Filterung aus.
Geben Sie Ihre Ziel-URL und Ihr Sicherheitstoken ein.
Geben Sie eine E-Mail-Adresse für Advanced Integrated Visibility-Updates und Ausfallbenachrichtigungen an.
Bestätigen von Angaben
Prüfen und akzeptieren Sie die FedEx Developer Portal-Lizenzvereinbarung und das Bestellformular.
Wählen Sie Erstellen aus, um die Einrichtung abzuschließen.
Hinweis: Je nach Abonnementart können zusätzliche Schritte erforderlich sein. Weitere Einzelheiten finden Sie in der Dokumentation.
Abrufen der Testanmeldedaten und Testbeginn
API-Dokumentation überprüfen
- Lesen Sie die API-Dokumentation, um die verschiedenen APIs, die wir anbieten, sowie deren Geschäftskontext und Integrationsprozesse zu verstehen.
- Laden Sie das JSON-Schema von der Dokumentationsseite der entsprechenden API herunter.
- Prüfen Sie Beispielanfragen für die gewünschten Endpunkte.
Testanmeldedaten abrufen
Gehen Sie auf der Seite Projektübersicht zur Registerkarte API-Schlüssel. Ihr API-Schlüssel und der geheime Schlüssel sind unter der Überschrift Testschlüssel aufgeführt.
API-Dokumentation überprüfen
- Für alle API-Transaktionen ist ein OAuth-Token erforderlich, das nach einer Stunde abläuft.
- Ihre Anwendung muss das Token aktualisieren, bevor es abläuft.
- Weitere Einzelheiten finden Sie in der Dokumentation zur API Authorization.
API-Transaktionen in der Sandbox testen
- Wechseln Sie zur relevanten API im API-Katalog und wählen Sie Dokumentation aus.
- Wählen Sie im Menü auf der linken Seite den gewünschten API-Endpunkt aus.
- Verwenden Sie Musteranfragen, die Ihrem Anwendungsfall entsprechen.
- Implementieren Sie API-Aufrufe mit Ihren Testanmeldedaten und FedEx Test-URLs.
- Verifizieren Sie die Antworten anhand der Dokumentation.
- Weitere Einzelheiten finden Sie in der Anleitung zur Sandboxvirtualisierung.
Testen von Advanced Integrated Visibility
Advanced Integrated Visibility-Tests validieren Ihr URL-Format und tragen dazu bei, eine Verbindung zwischen FedEx und Ihrer Anwendung herzustellen.
Der Test stellt Beispieldaten für die Verarbeitung von Tracking-Informationen bereit.
Hinweis: Ihre URL wird nicht durch die Tests authentifiziert.
Besuchen Sie die Dokumentation für Advanced Integrated Visibility, um mehr zu erfahren.
Für die Überführung von APIs in die Produktion ist eine Validierung erforderlich. Die Stufe der Validierung ist von der API abhängig.
Entwickeln und Testen von FedEx APIs
- Verwenden Sie Ihre Testanmeldedaten (API-Schlüssel und geheimer Schlüssel) auf der Projektübersichtsseite.
- Identifizieren Sie Testfälle für die Regionen/Gebiete, in denen Sie Ihre Lösung einsetzen möchten (siehe Referenzdokument für Integrator-Testfälle).
- Schließen Sie Registrierungstransaktionen mit den bereitgestellten Testkundennummern ab, bevor Sie Testfälle ausführen.
- Führen Sie alle erforderlichen Testfälle aus.
Wechseln Sie zu Ihrer Projektübersichtsseite.
Wählen Sie Produktionsschlüssel anfordern. FedEx nimmt Ihre Anforderung von Produktionsschlüsseln entgegen und Sie erhalten eine Benachrichtigung, sobald diese genehmigt ist.
Ausfüllen von PIW und Validierungsdeckblatt
Tragen Sie Ihre Kontaktdaten und die beabsichtigten FedEx Services in das Product Information Worksheet (PIW) und in das Integrator-Validierungsdeckblatt ein.
Einreichen der Arbeitsergebnisse
Sammeln und komprimieren Sie die folgenden Informationen in einer ZIP-Datei, um Einschränkungen des E-Mail-Anbieters zu umgehen. Senden Sie die Datei an validationmtp@fedex.com.
Erforderliche Arbeitsergebnisse
- Ausgefülltes PIW (PDF-Format)
- Ausgefülltes Validierungsdeckblatt (PDF-Format)
Screenshots (PDF-Format):
Kundenseitige Lösung bei Anzeige von FedEx Services/speziellem Handling
Haftungsausschluss
Ihrer Endbenutzer-Lizenzvereinbarung
Ihrem Endkunden-Registrierungsprozess
- Endkunden-Registrierungstransaktionen mit Multi-Faktor-Authentifizierung (JSON)
- Gescannte Versandetiketten für alle relevanten Testfälle (PDF/PNG)
- Versandtransaktionen für drei Etikettenformate: PDF, PNG und ZPL (JSON) (für relevante Versand- und Bewertungs-APIs)
Bewährte Verfahren zur Vermeidung von Verzögerungen
- Etiketten müssen mit mindestens 600 DPI gedruckt und gescannt werden.
- Thermodrucketiketten müssen zum Druckermodell passen (z. B. ZPLII für Zebra-Drucker).
- FedEx International Express® Sendungen erfordern ein zusätzliches Luftfrachtbriefetikett (AWB).
- Mehrpaketsendungen (MPS) müssen ein Etikett für jedes Paket enthalten.
Etikettbewertung
Das Validierungsteam wird Ihre Einreichung zulassen oder ablehnen.
- Wenn sie abgelehnt wird, nehmen Sie Korrekturen auf Grundlage des Feedbacks vor und reichen Sie erneut ein.
- Wenn sie zugelassen wird, erhalten Sie eine E-Mail mit der Bestätigung, dass die Validierung erfolgreich war. Nach Erhalt der E-Mail werden Ihre Produktionsanmeldedaten für Versandetikett-Transaktionen autorisiert.
Befolgen der Anweisungen nach der Validierung
Überprüfen und implementieren Sie alle Anforderungen nach der Validierung nach Bedarf.
Rufen Sie Ihre Produktionsschlüssel über die Registerkarte „Projektübersicht“ ab, sobald Sie die Benachrichtigung erhalten, dass Ihre Produktionsschlüssel genehmigt wurden.
- Kopieren Sie Ihren Produktions-API-Schlüssel und den geheimen Schlüssel und bewahren Sie beide Schlüssel sicher auf.
- Der geheime Schlüssel wird nur einmal angezeigt – wenn er verloren geht, müssen Sie einen neuen generieren.
