API-urile FedEx acceptă metoda de autentificare OAuth 2.0 (token la purtător) în vederea autorizării solicitărilor dvs. din cadrul API-urilor, prin utilizarea resurselor FedEx. Acest token de acces OAuth trebuie să fie generat din nou la fiecare 60 de minute și trebuie furnizat împreună cu fiecare tranzacție API pentru a autentificare și pentru autorizarea accesului la resursele FedEx.

Acest API vă permite să autorizați solicitările API și este necesar pentru a autentifica resursele FedEx. Următoarea secțiune descrie condițiile preliminare pentru folosirea API-ului:

Atunci când vă înregistrați pe FedEx Developer Portal, FedEx oferă o combinație între ID-ul de client (cheia API) și secretul de client (cheia secretă) pentru autentificarea solicitărilor API pentru proiectul dvs. Fiecare proiect din cadrul organizației dvs. este asociat cu o combinație dintre ID-ul de client și secretul de client Secret, numită acreditare API.

Notă: clienții (interni, compatibili sau proprietari) pot contacta reprezentantul FedEx pentru a obține API-ul și cheile secrete.

Pentru a oferi un nivel suplimentar de securitate, clienții FedEx^® (interni, compatibili sau proprietari) pot trimite cheia fiu (secretul clientului) și secretul fiu (parola clientului) în plus față de cheia API și cheia secretă pentru a crea un token OAuth. Acest token este utilizat în fiecare solicitare API pentru autentificare.

Puteți recrea cheia secretă uitată din pagina Proiecte de pe FedEx Developer Portal.

Notă: Crearea unor chei noi va rezulta în schimbarea codului în aplicația dvs.

Informații importante din acest document:

• Cheia de client drept cheie API
• Secret de client drept cheie secretă
• Cheia fiu drept cheie de client
• Secretul fiu drept parolă a clientului

Acreditările API servesc următoarele scopuri:

• Identifică proiectul efectuând un apel la API-uri.
• Autorizează accesul la API-urile care sunt activate în cadrul proiectului dvs.

Acreditările sunt create pe baza intrărilor din Portalul pentru dezvoltatori FedEx:

• ID de client – Cheia API (ID-ul de client) este creată după crearea unui proiect pe FedEx Developer Portal. De asemenea, puteți vizualiza cheia API asociată cu proiectul pe pagina Prezentare generală proiect.
• Secret de client – Veți vedea cheia secretă (secretul clientului) pe pagina de confirmare după crearea unui proiect pe FedEx Developer Portal. La nevoie, cheia secretă poate, de asemenea, să fie generată din nou pe pagina Prezentare generală proiect.

Notă: clienții FedEx^® (interni, compatibili sau proprietari) trebuie să trimită cheia fiu (secretul clientului) și secretul fiu (parola clientului) în plus față de cheia API și cheia secretă pentru a crea un token OAuth. Consultați API-ul de înregistrare a acreditărilor pentru a afla cum să obțineți cheia fiu și secretul fiu.

Autorizare API

După ce ați obținut acreditările API pe FedEx Developer Portal, utilizați acest punct final OAuth pentru a obține un token de acces care să fie utilizat ca acreditare pentru fiecare tranzacție API.

Acestea sunt intrările necesare asociate cu solicitarea OAuth:

• grant_type – Tip de client. (Valori valide: client_credentials, csp_credentials, client_pc_credentials)
• client_id – Se referă la cheia API de proiect.
• client_secret – Se referă la cheia secretă API a proiectului.

Pentru clienții interni, compatibili sau proprietari FedEx^® , trimiteți intrările suplimentare de mai jos:

• child_id – Cheia de client returnată prin solicitarea API de înregistrare a acreditărilor.
• child_secret – Parola de client returnată prin solicitarea API de înregistrare a acreditărilor

Rezultatul acestei solicitări ar trebui să returneze cele de mai jos:

• access_token – Tokenul OAuth criptat care trebuie utilizat în tranzacția API.
• token_type – Tip de token. În acest caz, este autentificarea purtătorului.
• expires_in – Timpul de expirare a tokenului în milisecunde. O oră este timpul de expirare standard al tokenului.
• Scope – Sfera de aplicare a autorizației furnizate consumatorului.

Exemple

Solicitare:

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

Răspuns:

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

Solicitare pentru clienții interni și compatibili FedEx^®:

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

Răspuns:

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

Solicitare pentru clienții proprietari FedEx^®:

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

Răspuns:

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

Notă: Tokenul de acces expiră într-o oră, poate fi regenerat prin utilizarea unei solicitări POST către punctul final oauth/token.