A FedEx-API-k támogatják az OAuth 2.0 (hordozói token) hitelesítési módszert az Ön által az alkalmazáson keresztül beküldött API-kéréseinek FedEx-erőforrások általi hitelesítéséhez. Ezt a OAuth-hozzáférési tokent 60-percenként újra kell generálni, és minden egyes API-tranzakció esetén szükséges megadni a FedEx-erőforrások Ön általi elérésének hitelesítéséhez és engedélyezéséhez.

Ezzel az API-val hitelesítheti az API-kéréseket, és szükség van rá a FedEx-erőforrások hitelesítéséhez. A következő rész tartalmazza az API előfeltételeit:

Amikor Ön regisztrál a FedEx Developer Portalra, a FedEx biztosítja Önnek egy ügyfél-azonosító (API-kulcs) és egy ügyfélkód (titkos kulcs) kombinációját, hogy hitelesíthesse a projektjével kapcsolatos API-kéréseket. A szervezete alá tartozó összes projekthez kapcsolódik egy ügyfél-azonosító és egy ügyfélkód kombinációja, amelyet hitelesítési API-adatoknak nevezünk.

Megjegyzés: Az ügyfelek (Internal, Compatible, Proprietary Parent Child és Integrator) a FedEx képviselőjének megkeresésével szerezhetik be az API-kulcsokat és a titkos kulcsokat.

A biztonság fokozása céljából a FedEx^® ügyfelei (Internal, Compatible, Proprietary Parent Child és Integrator) alárendelt kulcsot (ügyfélkódot) és alárendelt kódot (ügyféljelszót) küldhetnek az API-kulcson és a titkos kulcson kívül az OAuth-token létrehozása érdekében. Ez a token használatos hitelesítésre az összes API-kérés esetében.

Elfelejtett titkos kulcs esetén újat hozhat létre a FedEx Developer Portal Projektek oldalán.

Megjegyzés: Új kulcsok létrehozása esetén módosul a kódolás az alkalmazásán belül.

Fontos információk ebben a dokumentumban:

• Ügyfélkulcs használata API-kulcsként
• Ügyfélkód használata titkos kulcsként
• Alárendelt kulcs használata ügyfélkulcsként
• Alárendelt kód használata ügyféljelszóként

Az API hitelesítési adatai a következő célokat szolgálják:

• Azonosítják azt a projektet, amely hívást indít az API-k irányába.
• Jóváhagyják az Ön projektjében engedélyezett API-khoz való hozzáférést.

A hitelesítő adatok a FedEx Developer Portal-on megadott adatok alapján jönnek létre:

• Ügyfélazonosító – Az API-kulcs (Ügyfélazonosító) akkor jön létre, amikor létrehoznak egy projektet a FedEx Developer Portalon. Meg is tekintheti a projekthez kapcsolódó API-kulcsot a Projekt áttekintése oldalon.
• Ügyfélkód – Látni fogja a titkos kulcsot (ügyfélkódot) a megerősítő oldalon, amint létrehoznak egy projektet a FedEx Developer Portalon. Szükség esetén újra is lehet generálni a titkos kulcsot a Projekt áttekintése oldalon.

Megjegyzés: a FedEx^® ügyfeleinek (Internal, Compatible, Proprietary Parent Child és Integrator) alárendelt kulcsot (ügyfélkódot) és alárendelt kódot (ügyféljelszót) kell beküldeniük az API-kulcson és a titkos kulcson kívül az OAuth-token létrehozása érdekében. Az alárendelt kulcs és az alárendelt kód lekéréséhez olvassa el a hitelesítésiadat-regisztrációs API leírását.

API-hitelesítés

Miután biztosította az API hitelesítő adatait a FedEx Developer Portalon, az Oauth végpontot a hozzáférési token lekéréséhez használjuk, amelyet minden egyes API-tranzakcióhoz hitelesítő adatként használunk.

Ezek OAuth-kérelemhez kapcsolódó, kötelezően bevitt adatok:

• grant_type – Az ügyfél típusa. (Érvényes értékek: client_credentials, csp_credentials, client_pc_credentials)
• client_id – A projekt API-kulcsára utal.
• client_secret – A projekt API titkos kulcsára utal.

A FedEx^® Internal-, Compatible-, Proprietary Parent Child- és Integrator-ügyfelek esetén küldje be az alábbi kiegészítő adatokat:

• child_id – A hitelesítésiadat-regisztrációs API kérésén keresztül visszaküldött ügyfélkulcs.
• child_secret – A hitelesítésiadat-regisztrációs API kérésén keresztül visszaküldött ügyféljelszó

Ennek a kérésnek az alábbi eredményt kell visszaadnia:

• access_token – Az a titkosított OAuth-jogkivonat, amelyet az API-tranzakcióban kell használni.
• token_type – A jogkivonat típusa. Ebben az esetben ez a hordozói hitelesítés.
• expires_in – A jogkivonat lejárati ideje milliszekundumban. A jogkivonat standard lejárati ideje egy óra.
• Scope – A fogyasztónak adott felhatalmazás terjedelme.

Példák

Kérés:

POST /oauth/token HTTP/1.1
grant_type= client_credentials&client_id=your client ID&client_secret=Your secret

Válasz:

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

Kérés a FedEx^® Internal-, Compatible- és Integrator-ügyfelekhez:

POST /oauth/token HTTP/1.1
grant_type= csp_credentials&client_id=Client ID&client_secret= Client secret&child_key=Child key&child_secret=Child Secret

Válasz:

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

Kérés a FedEx^® Proprietary Parent Child ügyfelekhez:

POST /oauth/token HTTP/1.1
grant_type= client_pc_credentials&client_id=Client ID&client_secret= Client secret&child_key=Child key&child_secret=Child Secret

Válasz:

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

Megjegyzés: A hozzáférési token 1 óra alatt lejár. Az OAuth/jogkivonat-végpontra küldött UTÓLAGOS kéréssel újra lehet generálni.