Shell hitelesítés – Gyors útmutató

Bevezetés

A Shell hitelesítési API lehetővé teszi a partneralkalmazások számára, hogy az OAuth 2.0 kliens hitelesítőadatok áramlásának segítségével hitelesítsék magukat az API Gateway-en. Ez az API időkorlátozott hozzáférési tokeneket biztosít, amelyek engedélyezik a Shell API-khoz intézett kéréseket, így garantálva az alkalmazás és a Shell szolgáltatásai közötti biztonságos kommunikációt.

Hitelesítés

Áttérési megjegyzés

Ez az API az OAuth-token végpont v1-es és v2-es verzióit egyaránt biztosítja. Az 1. verzió elavult, és egy közelgő frissítési ciklusban eltávolításra kerül. Az új integrációknak a v2-t kell használniuk, a meglévő felhasználóknak pedig a lehető leghamarabb át kell állniuk a v2-re. A főbb különbségek a válaszformátumban vannak: a v2 a szabványos OAuth mezőneveket használja (expires_in a expires_in(seconds) helyett, valamint Bearer a BearerToken helyett).

Engedélyezési folyamat

1. Ügyfél-azonosító és titkos kulcs igénylése

Vegye fel a kapcsolatot a Shell API csapattal az OAuth-hitelesítéshez való hozzáférés igényléséhez. A Shell API csapat megadja az ügyfél-azonosítót és a titkos kulcsot.

2. Bearer token igénylése

Miután megkapta a hitelesítő adatokat, küldjön kérést a Shell Authentication API OAuth-token végpontjához a hitelesítő adataival.

Példa kérelemre:

curl --location --request POST 'https://api-test.shell.com/v2/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=**************' \
--data-urlencode 'client_secret=**************' \
--data-urlencode 'grant_type=client_credentials'

A válaszban egy Bearer token-t fog kapni:

{
   "access_token": "**************",
   "expires_in": "899",
   "token_type": "Bearer"
}

Megjegyzés: A Bearer token lejárati ideje másodpercben van megadva.

3. API-kérelmek engedélyezése

A Shell API-k meghívásakor a kérelem fejlécében szerepeltesse a következőket.

Authorization: Bearer access_token

Alap-URL-ek

Alapvető integráció

1. OAuth-token generálása

Leírás: Kérjen OAuth-hozzáférési tokent az ügyfél hitelesítő adataival. Az API egy időkorlátos Bearer-tokent ad vissza, amelyet minden későbbi API-kérés Authorization fejlécében fel kell tüntetni. Biztonsági okokból a GET helyett a POST módszert használjuk a gyorsítótárazás megakadályozása érdekében.

Útvonal: POST /v2/oauth/token

Példakérés

curl --location --request POST 'https://api-test.shell.com/v2/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=twuwywTYUHAH6AHHJ' \
--data-urlencode 'client_secret=yuahaYThdvdowoUUU7wjsjMM' \
--data-urlencode 'grant_type=client_credentials'

Kérésparaméterek

Minta válasz

{
  "access_token": "NiE3gzPNVFpwYYMyyWu6mGFYtKN5",
  "expires_in": "899",
  "token_type": "Bearer"
}

Válaszparaméterek

Hibakezelés

Az API szabványos HTTP-állapotkódokat használ. Hiba esetén további részletek szerepelnek a válasz törzsében.