1. Ein Projekt erstellen, um Zugangsdaten zu erhalten
2. APIs integrieren und Ihre Implementierung testen
3. Ihr Projekt in die Produktion verschieben
4. Ihre Zertifizierung abschließen

Ein*e Administrator*in oder ein Contributor Ihrer Organisation kann ein API-Projekt erstellen, indem er*sie auf die Projektschaltfläche API-Projekt erstellen klickt.

Lassen Sie uns zunächst jedoch wissen, warum Sie Zugriff auf FedEx APIs benötigen. In einem modalen Fenster werden in einer Dropdownliste verschiedene Optionen angezeigt. Wählen Sie die Option aus, die Ihre Geschäftsanforderungen für eine Integration der FedEx APIs am besten beschreibt.

Gehen Sie wie folgt vor, wenn Sie als Versender*in ein eigenes Projekt erstellen möchten:

APIs auswählen

Wählen Sie die API(s) aus, die Sie in Ihrem Projekt nutzen möchten. Abhängig von der/den API(s) müssen Sie möglicherweise weiteres auswählen.

Bei der Auswahl der Sendungsverfolgungs-API müssen Sie zusätzlich:

• Eine Kundennummer auswählen, die Ihrem Produktionsschlüssel zugeordnet wird.
• Kontingente, Transaktionsraten und Angaben zur API-Zertifizierung der Sendungsverfolgungs-API überprüfen.
• Entscheiden, ob Sie Benachrichtigungen erhalten möchten, wenn Ihre Transaktionskontingente überschritten werden.

Projekt konfigurieren

Geben Sie Projektdetails an, zum Beispiel einen Namen und den Versandort.

• 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.

Angaben bestätigen

Prüfen Sie die Projektdetails und akzeptieren Sie dann die Allgemeinen Geschäftsbedingungen.

• Lesen und akzeptieren Sie die Lizenzvereinbarung für das FedEx Developer Portal. Sie müssen bestätigen, dass Sie nicht beabsichtigen, Ihre Anwendung zu vertreiben.
• Wenn Sie auf die Schaltfläche „Erstellen“ klicken, wird ein Bestätigungsbildschirm angezeigt. Sie können nun innerhalb Ihres neuen Projekts Ihre Testzugangsdaten anzeigen.

• Fordern Sie ein OAuth-Zugriffstoken an, das bei jeder API-Transaktion verwendet werden muss. 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 den API-Autorisierungsdokumenten.
• Klicken Sie auf ein beliebiges Dokument für Ihre APIs, um den geschäftlichen Kontext zu lesen und um nachzuvollziehen, wie Sie die ausgewählte API am besten verwenden. Sie können auch Beispielanfragen für Endpunkte prüfen, die Ihrer gewünschten Integration entsprechen.
• Implementieren Sie Ihre Aufrufe an diese Endpunkte wie in den Beispielanfragen beschrieben und konfigurieren Sie diese mit Ihren Testzugangsdaten.
• Vergewissern Sie sich, dass die API-Aufrufantworten, die Sie empfangen, mit den in der Dokumentation angegebenen übereinstimmen.
• Testen Sie Ihre Implementierung innerhalb der FedEx Testumgebung unter Verwendung der Testzugangsdaten und der FedEx Test-URLs.

Schritt Projekt konfigurieren:

• Sie können Ihren Schlüssel bei Bedarf umbenennen.
• 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 Projektschlüssel abrufen:

• Ihr Produktions-API-Schlüssel und Ihr geheimer Produktionsschlüssel werden angezeigt. Speichern Sie diese unbedingt an einen sicheren Ort.
• Aus Sicherheitsgründen wird Ihr geheimer Produktionsschlüssel nur einmal angezeigt. Wenn Sie ihn verlieren, können Sie einen neuen erstellen.
• Klicken Sie auf Weiter.

Sie werden zurück zur Seite Projektübersicht geleitet. Hier können Sie weitere mit Ihrem Projekt verknüpfte Kundenkonten hinzufügen.

Seite Projektübersicht:

• Klicken Sie auf die drei vertikalen Punkte, um Ihrem Projekt weitere verknüpfte Kundenkonten hinzuzufügen.
• Klicken Sie auf Bearbeiten.

Sie werden auf die Seite API-Schlüssel weitergeleitet, wo Sie weitere Kundenkonten hinzufügen können, die Sie mit Ihrem Produktionsschlüssel für dieses Projekt verknüpfen möchten.

1. Einige APIs erfordern eine Zertifizierung für das Versandetikett zur Verwendung in unserer Produktionsumgebung. Schließen Sie den Zertifizierungsprozess für alle APIs in Ihrem Projekt mit dieser Anforderung ab.

1. Nachdem alle APIs zertifiziert und aktiviert wurden, aktualisieren Sie Ihre API-Anforderungen, indem Sie die Test-URIs, -Schlüssel und -Versandkonten durch die Produktions-URIs, -Schlüssel und -Versandkonten ersetzen.

2. Testen Sie Ihre Implementierung in der Produktionsumgebung erneut mithilfe von Beispieldaten.

3. Nutzen Sie die Vorteile Ihrer neuen Integration!

Voraussetzungen für das Erstellen eines Webhook-Projekts

1. Eine gültige URL in der Zielanwendung/-plattform erstellen
2. Sicherheitstoken erstellen
3. Webhook-URL testen
4. Ziel-URL validieren

Ein Webhook-Projekt erstellen

1. Erstellen Sie ein Webhook-Projekt, um Benachrichtigungen zur konfigurierten Nutzlast zu erhalten.

Voraussetzungen für das Erstellen eines Webhook-Projekts

Erstellen Sie eine gültige URL in Ihrer Zielanwendung/-plattform, um Authentifizierungscodes und Benachrichtigungen über die Tracking-Webhook-Nutzlast von FedEx zu erhalten.

Anforderungen an die URL:

Dieses Sicherheitstoken kann als geheimer Schlüssel zur Authentifizierung und Validierung der zwischen Ihnen (Kund*in) und FedEx übermittelten Informationen verwendet werden.

Anforderungen an das Sicherheitstoken:

• Länge von min. 25 und max. 100 Zeichen
• 1 Großbuchstabe
• 1 Kleinbuchstabe
• 1 numerisches Zeichen

Das Testen der URL ist ein optionaler, jedoch empfehlenswerter Schritt.

Sie können durch das Testen herausfinden, ob die in Schritt 1 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.

Richten Sie über den HMAC SHA-256-Algorithmus ein Authentifizierungsverfahren ein, um die zwischen der Ziel-URL und FedEx übermittelten Informationen zu validieren.

1. Wenn Sie auf Erstellen klicken, generiert FedEx eine zufällige Challenge-Zeichenfolge, die Ihnen im Anfragetext gesendet wird. Sie müssen diese Challenge-Zeichenfolge im Gegenzug an FedEx im Antworttext zurücksenden.

1. Initialisieren Sie den Message Authentication Code (MAC) über den HMAC SHA-256-Algorithmus, um die Challenge-Zeichenfolge und das Sicherheitstoken (oder den geheimen Schlüssel) zu hashen (oder zu kombinieren) und so eine Hash-Signatur zu bilden.

1. Antworten Sie FedEx mit challengeString und challengeStringResponse im Antworttext und geben Sie den HTTP-Statuscode 200 (OK) oder 202 (ACCEPTED) an.

1. FedEx validiert dann die Challengezeichenfolge und deren Antwort.

• Wenn der Antworttext von FedEx empfangen wird, validiert FedEx challengeString und challengeStringResponse (oder die zuvor erstellte Hashsignatur) durch einen Vergleich mit der von FedEx erstellten challengeString und Hashsignatur.

• Wenn sowohl „challengeString“ als auch die HMAC-Signaturen übereinstimmen, waren die Validierung und der Workflow erfolgreich. Ansonsten schlägt die Validierung fehl und eine entsprechende Fehlermeldung wird angezeigt.

Ein Webhook-Projekt erstellen

Rufen Sie auf der Seite Meine Projekte die Registerkarte Webhooks auf.

Ein*e Administrator*in oder ein Contributor Ihrer Organisation kann ein Webhook-Projekt erstellen, indem er oder sie auf die Projektschaltfläche Webhook erstellen klickt.

Lassen Sie uns zunächst jedoch wissen, warum Sie Zugriff auf FedEx Webhooks benötigen. In einem modalen Fenster werden in einer Dropdownliste verschiedene Optionen angezeigt. Wählen Sie die Option aus, die Ihre Geschäftsanforderungen für eine Integration der FedEx Webhooks am besten beschreibt.

Gehen Sie wie folgt vor, wenn Sie als Versender*in ein eigenes Projekt erstellen möchten:

1. Ihre Geschäftsanforderungen ermitteln

• Wählen Sie die Option aus, die am besten beschreibt, warum Ihr Unternehmen FedEx Webhooks integrieren möchte.

1. Ebene und Ebenenfunktionen auswählen

• Wählen Sie entsprechend den Projektanforderungen entweder eine grundlegende oder erweiterte Webhook-Stufe für Ihr Projekt aus.
• Sie können die Stufe später jederzeit ändern.
• Abhängig von der Stufe muss eine monatliche Abonnementgebühr entrichtet werden.

• Wählen Sie die Funktionen aus, die Sie für Ihr Projekt konfigurieren möchten.
• Sie können diese Funktionen später bearbeiten.

1. Projektdetails konfigurieren

• Geben Sie Ihrem Projekt einen aussagekräftigen Namen.
• Geben Sie die zuvor erstellte Ziel-URL und das Sicherheitstoken an, die während der Authentifizierung vor der Einrichtung erstellt wurden.

Kundenkonten auswählen

• Wählen Sie aus einer Liste berechtigter Kundennummern (aus den USA oder Kanada) die Kundenkonten aus, die mit Ihrem Projekt verknüpft werden sollen.

  5. Angaben bestätigen und Bedingungen akzeptieren

• Prüfen Sie die konfigurierten Projektdetails.
• Lesen und akzeptieren Sie die Lizenzvereinbarung für das Developer Portal. Sie müssen bestätigen, dass Sie nicht beabsichtigen, Ihre Anwendung zu vertreiben.
• Lesen und akzeptieren Sie die Preisvereinbarung.
• Nach dem Klick auf die Schaltfläche Projekt erstellen:

1. Wenn Ihre Anfrage validiert und verarbeitet wurde, werden Sie zu einem Bestätigungsbildschirm weitergeleitet.

• Schlägt die Validierung fehl, wird eine Fehlermeldung angezeigt.

1. Ihr Tracking-Webhook-Projekt erhält dann eine vom System generierte Webhook-ID und wird als „aktiv“ angezeigt.

1. FedEx erstellt die Organisation für den Compatible Anbieter.
2. Nehmen Sie die Einladung an.
3. Laden Sie Benutzer zu Ihrer Organisation ein.
4. Wählen Sie die für Ihre Lösung erforderlichen APIs aus.
5. FedEx erstellt das Projekt/die Projekte.
6. Integrieren Sie APIs in Ihre Anwendung und lassen Sie diese über das Compatible Program zertifizieren.
7. FedeX verschiebt das Projekt/die Projekte in die Produktion.
8. Generieren Sie den geheimen Produktionsschlüssel.

• FedEx erstellt eine Organisation und sendet dann eine Einladung an ein Teammitglied. Diese*r Benutzer*in ist der*die Administrator*in Ihrer Organisation.
• Nach der Zertifizierung und Integration können Sie die Lösung Ihren Kunden ganz einfach bereitstellen.

• Um Zugriff auf die Artefakte und Dokumentation der API-Integration zu erhalten, müssen Sie die Einladung annehmen. Hierfür melden Sie sich entweder mit Ihrer FedEx Benutzer ID und Ihrem Passwort an oder erstellen neue Anmeldeinformationen.

• Als Admin können Sie jedes Teammitglied einladen, das Zugriff auf das Projekt oder die Organisation benötigt. Ausführliche Informationen über die verschiedenen Rollen finden Sie im Leitfaden zur Organisationsverwaltung.

• Wenn Ihre Organisation bereits erstellt wurde, bitten Sie den Admin der Organisation oder FedEx um eine Einladung. Sie haben 24 Stunden Zeit, eine Einladung anzunehmen. Wenn dieses Zeitfenster verstreicht, müssen Sie den Admin erneut um eine Einladung bitten.

• Rufen Sie den API-Katalog auf, um die richtigen APIs für Ihre Lösung zu bestimmen. Ihr*e FedEx Customer Technology Consultant*in (CTC) und Compatible Channel Manager*in helfen Ihnen gern bei der Auswahl der richtigen APIs für Ihre Lösung und Ihre Anforderungen.

• Wählen Sie eine API aus, um eine Übersicht, ein Änderungsprotokoll und wesentliche Merkmale anzuzeigen.

• Lesen Sie die dazugehörige API-Dokumentation, um mehr über Anfrage- und Antwortelemente, Beispielcode in der ausgewählten Sprache, Fehlerobjekte und mehr zu erfahren.

• Füllen Sie in Salesforce das Product Information Worksheet (PIW) mit den APIs aus, die Sie Ihrer Lösung hinzufügen möchten.

Nach der Genehmigung des PIW erstellt FedEx Ihr Projekt/Ihre Projekte. Jede Version all Ihrer Lösungen wird als eigenes Projekt im FedEx Developer Portal gespeichert. Benutzer, die nicht Admin der Organisation sind, benötigen eine Einladung, um ein Projekt anzuzeigen. 

Das gilt auch, wenn das FedEx Compatible Team mit den Teams für FedEx CTC und Zertifizierung eine technische Demonstration der APIs für Ihr Team bereitstellt. Das FedEx Team informiert Sie über neue Features und Funktionen in der von Ihnen verwendeten API-Version. Das Team beantwortet technische Fragen zu APIs, API-Tests und allen Vorgängen, die vor der Zertifizierung* für APIs abgeschlossen sein müssen.

* Zertifizierung: Der im FedEx Compatible Program festgeschriebene Vorgang, damit die Compliance-Anforderungen des Programms erfüllt werden. Mit der Zertifizierung wird sichergestellt, dass alle Compatible Anbieter die FedEx Technologie gemäß den Standards für FedEx Technologie und Services bei Versendern (Kunden) implementieren, an diese vermarkten und vertreiben.

1. Sie haben jetzt Zugriff auf Ihren API-Testschlüssel und Ihren geheimen Testschlüssel und können Transaktionen ausführen. Sie erhalten Ihre Testzugangsdaten auf der Seite „Projektübersicht“ über die Registerkarte „Testschlüssel“.

1. Um benutzerdefinierte Schlüssel zu erstellen, müssen Sie die API für die Registrierung von Zugangsdaten verwenden. Dabei handelt es sich um eine private API, die nur im API-Bereich des jeweiligen Projekts verfügbar ist.
2. Fordern Sie ein OAuth-Zugriffstoken an, das bei jeder API-Transaktion verwendet werden muss, sobald Sie einige benutzerdefinierte Schlüssel erstellt haben. Die Sitzung für das Token ist nur eine Stunde lang gültig. Sie müssen Ihre Anwendung so programmieren, dass das Token vor Ablauf der Sitzung aktualisiert wird. Weitere Einzelheiten finden Sie in den API-Autorisierungsdokumenten. Achten Sie bei der Anzeige von Beispielcode darauf, dass in der Dropdown-Liste mit Beispielen „Reseller“ ausgewählt ist.

1. Wählen Sie die entsprechenden API-Dokumente auf der Seite „Testschlüssel“ aus und lesen Sie den geschäftlichen Kontext, um nachzuvollziehen, wie Sie die ausgewählte API am besten verwenden. Prüfen Sie Beispielanfragen für Endpunkte, die Ihrer gewünschten Integration entsprechen.
2. Implementieren Sie Ihre Aufrufe an diese Endpunkte wie in den Beispielanfragen beschrieben und konfigurieren Sie diese mit Ihren Testzugangsdaten.
3. Vergewissern Sie sich, dass die empfangenen API-Aufrufantworten mit den in der Dokumentation angegebenen übereinstimmen.
4. Testen Sie Ihre Implementierung umfassend innerhalb der FedEx Testumgebung unter Verwendung der Testzugangsdaten und der FedEx Test-URIs.
5. Nach der vollständigen Überprüfung Ihrer Lösungen können Sie jede Lösung bei Salesforce zertifizieren. FedEx prüft alle übermittelten Inhalte und informiert Sie, sobald Ihre Zertifizierung genehmigt wurde.

• FedeX verschiebt Ihr Projekt/Ihre Projekte dann in die Produktion.
• Sie können Ihren Produktions-API-Schlüssel dann auf der Seite „Projektübersicht“ unter der Registerkarte „Produktionsschlüssel“ anzeigen.

• Ihr geheimer Produktionsschlüssel muss generiert werden. Klicken Sie hierfür 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.
• Nutzen Sie die Vorteile Ihrer neuen Integration!