Erste Schritte
Starten Sie die Integration und profitieren Sie von den Vorteilen von FedEx APIs. Die folgenden Anweisungen leiten Sie durch die Einrichtung einer Organisation, das Erstellen von Projekten sowie die ersten Schritte als kompatible*r Benutzer*in.
- Durchsuchen Sie die APIs, um zu bestimmen, was Sie für Ihre Anwendung benötigen.
- Registrieren Sie sich oder melden Sie sich an, um mit der Integration der FedEx APIs zu beginnen.
- Erstellen Sie eine Organisation oder treten Sie einer Organisation bei.
- Fügen Sie ein Versandkonto hinzu.
- Fügen Sie Benutzer zu Ihrer Organisation hinzu, um mit Ihren Kollegen zusammenarbeiten zu können.
- Erstellen Sie ein Projekt, um Zugangsdaten zu erhalten.
- Integrieren Sie APIs in Ihre Anwendung und testen Sie Ihre Implementierung.
- Verschieben Sie Ihr Projekt in die Produktion.
- Schließen Sie Ihre Integration ab.
Schritt 1:
Durchsuchen Sie die APIs, um zu bestimmen, was Sie für Ihre Anwendung benötigen.
- Rufen Sie den API-Katalog auf, um die richtigen APIs für Ihre Anwendung zu bestimmen.
- Wählen Sie eine API aus, um eine Übersicht, ein Änderungsprotokoll und wesentliche Merkmale anzuzeigen.
- Lesen Sie die zugehörigen API-Dokumente, um mehr über Anfrage- und Antwortelemente, Beispielcode in verschiedenen Programmiersprachen und Fehlercodes zu erfahren.
- Lesen Sie die Ankündigungen zu geplanten Service-Updates und informieren Sie sich über Neuigkeiten.
Schritt 2:
Registrieren Sie sich oder melden Sie sich an, um mit der Integration der FedEx APIs zu beginnen.
- Melden Sie sich mit Ihrer fedex.com Benutzerkennung und Ihrem Passwort an, um mit der Integration der FedEx APIs zu beginnen.
- Wenn Sie noch keine Benutzerkennung haben, können Sie sich kostenlos registrieren.
Schritt 3:
Erstellen Sie eine Organisation oder treten Sie einer Organisation bei.
Erstellen Sie entweder ein neues Unternehmen, sofern noch nicht vorhanden, oder treten Sie einem bestehenden Unternehmen bei. Sie können mehrere Benutzer mit Ihrem Unternehmen verknüpfen, jedoch nicht mehrere Unternehmen mit einer Benutzerkennung.
Wenn Sie eine Organisation erstellen, werden Sie automatisch als Administrator dieser Organisation geführt. Ein Administrator kann Benutzer in seine Organisation einladen, ihnen Rollen und Projekte zuweisen und Versandkonten verwalten. In unseren Richtlinien für die Organisationsverwaltung erfahren Sie, welche Rollen für wen am besten geeignet sind. Um Ihre eigene Organisation zu erstellen, klicken Sie auf Meine Projekte und dann auf „Organisation erstellen“. Diese Schaltfläche wird nur angezeigt, wenn Sie Ihre Benutzerkennung noch nicht mit einer vorhandenen Organisation verknüpft haben. Richten Sie die Organisation nun ein, indem Sie die folgenden Schritte ausführen (die mit einem Sternchen (*) gekennzeichneten Schritte sind optional):
- Geben Sie einen Unternehmensnamen ein.
- Geben Sie die E-Mail-Adressen der Teammitglieder ein, die Sie einladen möchten. Diese werden automatisch als Viewer hinzugefügt, denen keine Projekte zugeordnet sind.*
Sie können auch einem Unternehmen beitreten, indem Sie die folgenden Schritte ausführen:
- Wenn Ihr Unternehmen bereits ein Unternehmen erstellt hat, bitten Sie den Admin 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.
- Um die Einladung anzunehmen, müssen Sie sich entweder mit Ihrer vorhandenen Benutzerkennung und Ihrem Passwort anmelden oder eine neue Benutzerkennung erstellen, sofern Ihre Benutzerkennung bereits einer Organisation zugeordnet ist.
Schritt 4:
Fügen Sie ein Versandkonto hinzu.
Ein Administrator kann einer Organisation so viele Versandkonten wie nötig hinzufügen. Klicken Sie hierfür zunächst auf der Seite Organisation verwalten unter der Registerkarte „Versandkonten“ auf „Konto hinzufügen“. Fügen Sie Ihrer Organisation nun ein vorhandenes Versandkonto hinzu, indem Sie die folgenden Schritte ausführen:
- Kontoinformationen ausfüllen
Geben Sie Ihre Kundennummer, ggf. den Anzeigename des Kontos und die mit dem Konto verknüpfte Rechnungsadresse ein. Die von Ihnen eingegebenen Informationen werden mit den Kontodaten abgeglichen, um betrügerische Aktivitäten zu verhindern.
Rufen Sie die Seite „Ship Admin“ auf, um die mit Ihrer Benutzer-ID verknüpften Versandkonten anzuzeigen. Wenn Sie neue Versandkonten erstellen möchten, wenden Sie sich an den FedEx Vertriebsmitarbeitenden.
- Endbenutzer-Lizenzvereinbarung
Sie müssen dann die Endbenutzer-Lizenzvereinbarung (EULA) akzeptieren oder an die richtige Kontaktperson innerhalb der Endbenutzerorganisation senden. Sie können den Status der EULA auf der Seite Organisation verwalten unter der Registerkarte „Versandkonten“ anzeigen.
Schritt 5:
Fügen Sie Benutzer zu Ihrer Organisation hinzu, um mit Ihren Kollegen zusammenarbeiten zu können.
Ein Administrator kann Benutzer in seine Organisation einladen und ihnen Rollen und Projekte zuweisen. Klicken Sie hierfür zunächst auf der Seite Organisation verwalten unter der Registerkarte „Benutzer“ auf „Benutzer hinzufügen“. Fügen Sie nun Benutzer hinzu, indem Sie die folgenden Schritte ausführen (die mit einem Sternchen (*) gekennzeichneten Schritte sind optional):
- Geben Sie die E-Mail-Adressen der Benutzer ein, die Sie zu Ihrer Organisation hinzufügen möchten. Geben Sie mehrere E-Mail-Adressen ein, indem Sie Leerzeichen, Kommas oder Semikolons verwenden oder die Eingabetaste auf Ihrer Tastatur drücken.
- Wählen Sie eine Rolle aus, wenn die Standardoption „Viewer“ für den Benutzer nicht geeignet ist.*
- Wählen Sie ein mit Ihrer Organisation verknüpftes Projekt aus, um Benutzer zuzuordnen. Informationen zum Erstellen von Projekten finden Sie im nächsten Schritt.*
Ein Administrator hat stets Zugriff auf alle Projekte, ein Contributor oder Viewer muss einem Projekt erst zugewiesen werden. Ein Contributor hat ebenfalls Zugriff, sofern er das Projekt selbst erstellt hat. Unabhängig davon, ob ein Benutzer die Einladung bereits angenommen hat oder nicht, können Sie dessen Projekte und Rollen auf der Seite „Unternehmensadministration“ unter der Registerkarte „Benutzer“ aktualisieren. Klicken Sie neben der Rolle oder dem Projekt einfach auf das Auslassungszeichen, um eine Dropdown-Liste mit Optionen anzuzeigen. Wählen Sie die gewünschte Option aus und bestätigen Sie Ihre Auswahl über die Schaltfläche „Übernehmen“.
Schritt 6:
Erstellen Sie ein Projekt, um Zugangsdaten zu erhalten.
Auf der Seite Meine Projekte können Sie als Administrator oder Contributor ein Projekt erstellen, indem Sie die entsprechende Schaltfläche auswählen. Richten Sie das Projekt nun ein, indem Sie die folgenden Schritte ausführen (die mit einem Sternchen (*) gekennzeichneten Schritte sind optional):
1. Projekt einrichten
- Geben Sie Ihrem Projekt einen markanten Namen, der für Ihre Organisation eindeutig ist.
- Wählen Sie zunächst mindestens eine API aus, die Sie zu Ihrem Projekt hinzufügen möchten. Sie können APIs zu einem späteren Zeitpunkt jederzeit hinzufügen oder entfernen.
2. Nutzungsbedingungen akzeptieren
- Lesen und akzeptieren Sie die Lizenzvereinbarung für das Developer Portal. Sie müssen bestätigen, dass Sie nicht beabsichtigen, Ihre Anwendung zu vertreiben.
- 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 Inlandsversand 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 FedEx Ground® Economy Returns oder FedEx Freight® LTL verwenden möchten, wählen Sie „Ja“ aus.*
- Wenn Sie auf die Schaltfläche „Erstellen“ klicken, wird ein Bestätigungsbildschirm angezeigt. Sie können nun innerhalb Ihres neuen Projekts Ihre Testzugangsdaten anzeigen.
Schritt 7:
Integrieren Sie APIs in Ihre Anwendung und testen Sie Ihre Implementierung.
- Rufen Sie die Testzugangsdaten (API-Schlüssel, Geheimschlüssel und Versandkonten) auf der Seite „Projektübersicht“ über die Registerkarte „Testschlüssel“ ab.
- Fordern Sie ein OAuth-Zugriffstoken an, das bei jeder API-Transaktion verwendet werden muss. Die Sitzung für 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.
- 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.
- Implementieren Sie Ihre Aufrufe an diese Endpunkte wie in den Beispielanfragen beschrieben und konfigurieren Sie diese mit Ihren Testzugangsdaten.
- Vergewissern Sie sich, dass die empfangenen API-Aufrufantworten mit den in der Dokumentation angegebenen übereinstimmen.
- Testen Sie Ihre Implementierung umfassend innerhalb der FedEx Testumgebung unter Verwendung der Testzugangsdaten und der FedEx Test-URIs.
Schritt 8:
Verschieben Sie Ihr Projekt in die Produktion.
Klicken Sie auf der Projektübersichtsseite auf die Registerkarte „Produktionsschlüssel“. Verschieben Sie dann das Projekt, indem Sie die folgenden Schritte ausführen (die mit einem Sternchen (*) gekennzeichneten Schritte sind optional):
- Projekt konfigurieren
- Benennen Sie Ihren Produktions-API-Schlüssel um.*
- Nun müssen Sie ein Versandkonto hinzufügen. Sie können weitere hinzufügen, nachdem Ihr Projekt erfolgreich in die Produktion verschoben wurde. Wenn Ihrem Unternehmen keine Versandkonten zugeordnet sind oder wenn die EULA für Versandkonten nicht unterzeichnet wurde, werden in der Dropdown-Liste keine angezeigt.
- Projektschlüssel abrufen
- Als Nächstes werden Ihre Produktions-API-Schlüssel und Ihr geheimer Produktionsschlüssel 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.
Schritt 9:
Schließen Sie Ihre Integration ab.
- Einige APIs erfordern entweder eine grundlegende Zertifizierung oder eine Versandetikettzertifizierung für die Verwendung in unserer Produktionsumgebung. Schließen Sie den Zertifizierungsprozess für alle APIs in Ihrem Projekt mit dieser Anforderung ab.
- 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
- Testen Sie Ihre Implementierung in der Produktionsumgebung erneut mithilfe von Beispieldaten.
- Nutzen Sie die Vorteile Ihrer neuen Integration!
Sie sind kein Entwickler oder fragen sich, ob Ihr Unternehmen bereit für die Integration von FedEx APIs ist? Erfahren Sie jetzt, wie Ihr Unternehmen von einer Integration profitiert.
- FedEx erstellt die Organisation für den Compatible Anbieter.
- Nehmen Sie die Einladung an.
- Laden Sie Benutzer zu Ihrer Organisation ein.
- Wählen Sie die für Ihre Lösung erforderlichen APIs aus.
- FedEx erstellt das Projekt/die Projekte.
- Integrieren Sie APIs in Ihre Anwendung und lassen Sie diese über das Compatible Program zertifizieren.
- FedeX verschiebt das Projekt/die Projekte in die Produktion.
- Generieren Sie den geheimen Produktionsschlüssel.
Schritt 1:
FedEx erstellt die Organisation für den Compatible Anbieter.
- FedEx erstellt eine Organisation und sendet dann eine Einladung an ein Teammitglied. Dieser Benutzer ist der „Admin“ Ihrer Organisation.
- Nach der Zertifizierung und Integration können Sie die Lösung Ihren Kunden ganz einfach bereitstellen.
Schritt 2:
Nehmen Sie die Einladung an.
- 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.
Schritt 3:
Laden Sie Benutzer zu Ihrer Organisation ein.
- 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.
Schritt 4:
Wählen Sie die für Ihre Lösung erforderlichen APIs aus.
Rufen Sie den API-Katalog auf, um die richtigen APIs für Ihre Lösung zu bestimmen. Ihr FedEx Customer Technology Consultant (CTC) und Compatible Channel Manager 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.
Schritt 5:
FedEx erstellt das Projekt/die Projekte.
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.
Schritt 6:
Integrieren Sie APIs in Ihre Anwendung und lassen Sie diese über das Compatible Program zertifizieren.
- 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“.
- 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.
- 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.
- 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.
- Implementieren Sie Ihre Aufrufe an diese Endpunkte wie in den Beispielanfragen beschrieben und konfigurieren Sie diese mit Ihren Testzugangsdaten.
- Vergewissern Sie sich, dass die empfangenen API-Aufrufantworten mit den in der Dokumentation angegebenen übereinstimmen.
- Testen Sie Ihre Implementierung umfassend innerhalb der FedEx Testumgebung unter Verwendung der Testzugangsdaten und der FedEx Test-URIs.
- 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.
Schritt 7:
FedeX verschiebt das Projekt/die Projekte in die Produktion.
- 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.
Schritt 8:
Generieren Sie den geheimen Produktionsschlüssel.
- 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!
