Hitri začetek za avtentifikacijo Shell

Uvod

API za avtentifikacijo Shell omogoča partnerskim aplikacijam avtentifikacijo prek API Gateway z uporabo postopka za avtentifikacijo stranke OAuth 2.0. Ta API zagotavlja časovno omejene dostopne žetone, ki avtorizirajo zahteve do Shellovih API-jev ter tako zagotavljajo varno komunikacijo med vašo aplikacijo in Shellovimi storitvami.

Preverjanje pristnosti

Opomba o migraciji

Ta API ponuja različici v1 in v2 končne točke za žetone OAuth. Različica 1 je zastarela in bo odstranjena v naslednjem obdobju sprememb. Nove integracije morajo uporabljati različico v2, obstoječi uporabniki pa morajo čim prej preiti na različico v2. Glavne razlike so v formatu odgovora: različica v2 uporablja standardna imena polj OAuth (expires_in namesto expires_in(seconds) ter Bearer namesto BearerToken).

Postopek avtorizacije

1. Zahteva za ID stranke in skrivni ključ

Obrnite se na ekipo Shell API, da zahtevate dostop do avtentifikacije OAuth. Ekipa Shell API vam bo posredovala ID stranke in skrivni ključ.

2. Zahtevajte Bearer token

Ko prejmete poverilnice, pošljite zahtevo na končno točko za OAuth-token API-ja za avtentifikacijo Shell s svojimi poverilnicami.

Primer zahtevka:

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'

V odgovoru boste prejeli žeton Bearer:

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

Opomba: Čas poteka veljavnosti žetona Bearer je naveden v sekundah.

3. Avtorizacija zahtevkov API

Pri klicu API-jev Shell v glavo zahtevka vključite naslednje.

Authorization: Bearer access_token

Osnovni URL-ji

Osnovna integracija

1. Ustvarjanje OAuth-token

Opis: Zahtevajte OAuth-token za dostop z uporabo svojih poverilnic odjemalca. API vrne časovno omejen Bearer-token, ki ga je treba vključiti v glavo »Authorization« vseh nadaljnjih zahtevkov API. Zaradi varnostnih ukrepov se namesto metode GET uporablja metoda POST, da se prepreči shranjevanje v predpomnilniku.

Pot: POST /v2/oauth/token

Primer zahtevka

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'

Parametri zahtevka

Primer odgovora

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

Parametri odgovora

Obravnavanje napak

API uporablja standardne HTTP-statusne kode. V primeru napake bodo dodatni podatki navedeni v telesu odgovora.