Die FedEx APIs unterstützen die OAuth 2.0-Authentifizierungsmethode (mit Inhaber-Token) zur Autorisierung Ihrer API-Abfragen bei FedEx Ressourcen. Dieses OAuth-Zugriffstoken muss alle 60 Minuten neu generiert und für jede API-Transaktion bereitgestellt werden, damit Ihr Zugriff auf die Ressourcen authentifiziert und autorisiert werden kann.

Mit dieser API können Sie die API-Abfragen autorisieren. Außerdem ist es für die Authentifizierung der FedEx Ressourcen erforderlich. In folgendem Abschnitt werden die Grundvoraussetzungen der API erläutert:

Während der Registrierung beim FedEx Developer Portal stellt FedEx eine Kombination aus Kunden-ID (API-Schlüssel) und geheimem Kundenschlüssel für die Authentifizierung von API-Abfragen für Ihr Projekt bereit. Jedem Projekt Ihrer Organisation ist eine Kombination aus Kunden-ID und geheimem Kundenschlüssel, die sogenannten API-Anmeldeinformationen, zugeordnet.

Hinweis: Kund*innen (Internal, Compatible oder Proprietary Parent Child) können sich an FedEx Mitarbeitende wenden, um API- und geheime Schlüssel zu erhalten.

Als zusätzliche Sicherheitsmaßnahme können FedEx^® Kund*innen (Internal, Compatible oder Proprietary Parent Child) zusätzlich zum API-Schlüssel und geheimen Schlüssel untergeordnete Schlüssel (geheime Kundenschlüssel) und untergeordnete geheime Passwörter (Kundenpasswörter) senden, um ein OAuth-Token zu erstellen. Dieses Token wird bei jeder API-Anfrage zur Authentifizierung verwendet.

Wenn Sie den geheimen Schlüssel vergessen haben, können Sie diesen über die Projektseite im FedEx Developer Portal neu erstellen.

Hinweis: Das Erstellen neuer Schlüssel führt zu einer Änderung Ihres Anwendungs-Codes.

Wichtige Informationen in diesem Dokument:

• Kundenschlüssel – API-Schlüssel
• Geheimer Kundenschlüssel – geheimer Schlüssel
• Untergeordneter Schlüssel – Kundenschlüssel
• Untergeordnetes geheimes Passwort – Kundenpasswort

API-Anmeldeinformationen erfüllen folgende Aufgaben:

• Sie identifizieren das Projekt, über das eine Abfrage erfolgt, gegenüber den APIs.
• Sie autorisieren den Zugriff auf die für Ihr Projekt aktivierten APIs.

Das Erstellen von Anmeldedaten erfolgt über Eingaben im FedEx Developer Portal:

• Kunden-ID: Der API-Schlüssel (Kunden-ID) wird generiert, wenn im FedEx Developer Portal ein Projekt erstellt wurde. Sie können den dem Projekt zugeordneten API-Schlüssel auch auf der Seite Projektübersicht anzeigen.
• Geheimer Kundenschlüssel: Der geheime Schlüssel (Geheimer Kundenschlüssel) wird nach Erstellung eines Projekts im FedEx Developer Portal auf der Bestätigungsseite angezeigt. Bei Bedarf kann der geheime Schlüssel auch auf der Seite Projektübersicht neu erstellt werden.

Hinweis: FedEx^® Kund*innen (Internal, Compatible oder Proprietary Parent Child) müssen zusätzlich zum API-Schlüssel und geheimen Schlüssel untergeordnete Schlüssel (geheime Kundenpasswörter) und untergeordnete geheime Passwörter (Kundenpasswörter) senden, um das OAuth-Token zu erstellen. Weitere Informationen zum Abrufen des untergeordneten Schlüssels und des untergeordneten geheimen Passworts finden Sie in der API für die Registrierung von Zugangsdaten.

API-Autorisierung

Nachdem Sie die API-Anmeldeinformationen im FedEx Developer Portal gesichert haben, können Sie über den OAuth-Endpunkt ein Zugriffstoken abrufen und dieses als Anmeldeinformationen für Ihre API-Transaktionen nutzen.

Bei einer OAuth-Anforderung sind folgende Eingaben erforderlich:

• grant_type: Kundentyp. (Gültige Werte: client_credentials, csp_credentials, client_pc_credentials)
• client_id: verweist auf den API-Schlüssel für das Projekt.
• client_secret: verweist auf den geheimen API-Schlüssel für das Projekt.

FedEx^®  Internal-, Compatible- oder Proprietary Parent Child-Kund*innen senden die im Folgenden aufgeführten zusätzlichen Eingaben:

• child_id: der über die Abfrage „API für die Registrierung von Zugangsdaten“ abgerufene Kundenschlüssel.
• child_secret: das Kundenpasswort, das über die Abfrage „API für die Registrierung von Zugangsdaten“ abgerufen wird.

Als Ergebnis dieser Abfrage sollte Folgendes zurückgegeben werden:

• access_token: das verschlüsselte OAuth-Token, das für die API-Transaktion erforderlich ist.
• token_type: der Token-Typ. In diesem Fall: Inhaberauthentifizierung.
• expires_in: Gültigkeitsdauer des Token in Millisekunden. Die Standarddauer für die Gültigkeit eines Token beträgt eine Stunde.
• Scope: Umfang der Autorisierung, der dem*r Kunden*in zur Verfügung steht.

Beispiele

Abfrage:

POST/oauth/token HTTP/1.1
grant_type= client_credentials&client_id=Ihre Kunden-ID&client_secret=Ihr Passwort

Antwort:

{ ″access_token″: ″eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX……..″,
″token_type″: ″bearer″,
″expires_in″: 3600,
″scope″: ″CXS″
}

Abfrage für FedEx^® Internal- oder Compatible-Kunden*innen:

POST/oauth/token HTTP/1.1
grant_type= csp_credentials&client_id=Kunden-ID&client_secret= Kundenpasswort&child_key=untergeordneter Schlüssel&child_secret=untergeordnetes geheimes Passwort

Antwort:

{ ″access_token″: ″eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX……..″,
″token_type″: ″bearer″,
″expires_in″: 3600,
″scope″: ″CXS″
}

Anfrorderung für FedEx^® Proprietary Parent Child-Kund*innen:

POST/oauth/token HTTP/1.1
grant_type= client_pc_credentials&client_id=Kunden-ID&client_secret= Kundenpasswort&child_key=untergeordneter Schlüssel&child_secret=untergeordnetes geheimes Passwort

Antwort:

{ ″access_token″: ″eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX……..″,
″token_type″: ″bearer″,
″expires_in″: 3600,
″scope″: ″CXS″
}

Hinweis: Das Zugriffs-Token ist eine Stunde lang gültig. Es kann über eine POST-Abfrage am OAuth/Token-Endpunkt erneut generiert werden.