Rýchly sprievodca overovaním prostredníctvom Shell

Úvod

Rozhranie API pre overovanie prostredníctvom Shell umožňuje partnerským aplikáciám overovať sa v API Gateway pomocou postupu overovania prostredníctvom klientskych poverení OAuth 2.0. Toto rozhranie API poskytuje časovo obmedzené prístupové tokeny, ktoré autorizujú požiadavky na rozhrania API spoločnosti Shell, čím zabezpečuje bezpečnú komunikáciu medzi vašou aplikáciou a službami spoločnosti Shell.

Overovanie

Poznámka k migrácii

Toto API poskytuje verzie v1 aj v2 koncového bodu pre tokeny OAuth. Verzia 1 je zastaraná a bude odstránená v najbližšom okne zmien. Nové integrácie by mali používať verziu v2 a existujúci používatelia by mali čo najskôr prejsť na verziu v2. Hlavné rozdiely spočívajú vo formáte odpovede: verzia v2 používa štandardné názvy polí OAuth (expires_in namiesto expires_in(seconds) a Bearer namiesto BearerToken).

Autorizačný tok

1. Žiadosť o ID klienta a tajný kľúč

Obráťte sa na tím Shell API s žiadosťou o prístup k overovaniu OAuth. Tím Shell API vám poskytne ID klienta a tajný kľúč.

2. Žiadosť o token Bearer

Akonáhle získate prihlasovacie údaje, odošlite žiadosť na koncový bod pre token OAuth rozhrania Shell Authentication API so svojimi prihlasovacími údajmi.

Príklad požiadavky:

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 odpovedi dostanete token typu Bearer:

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

Poznámka: Čas vypršania platnosti tokenu typu „Bearer“ je uvedený v sekundách.

3. Autorizácia požiadaviek na API

Pri volaní rozhraní API Shellu zahrňte do hlavičky požiadavky nasledujúci text.

Authorization: Bearer access_token

Základné URL adresy

Základná integrácia

1. Generovanie tokenu OAuth

Popis: Požiadajte o prístupový token OAuth pomocou svojich klientskych poverení. API vráti časovo obmedzený token typu „Bearer“, ktorý musí byť zahrnutý v hlavičke „Authorization“ všetkých nasledujúcich požiadaviek na API. Z bezpečnostných dôvodov sa namiesto metódy GET používa metóda POST, aby sa zabránilo ukladaniu do vyrovnávacej pamäte.

Cesta: POST /v2/oauth/token

Ukážková požiadavka

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'

Parametre požiadavky

Vzorová odpoveď

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

Parametre odpovede

Spracovanie chýb

API používa štandardné stavové kódy HTTP. V prípade chyby budú v tele odpovede uvedené ďalšie podrobnosti.