Rychlý start pro ověřování Shell

Úvod

Rozhraní API pro ověřování Shell umožňuje partnerským aplikacím ověřovat se u API Gateway pomocí toku přihlašovacích údajů klienta OAuth 2.0. Toto API poskytuje časově omezené přístupové tokeny, které autorizují požadavky na API společnosti Shell a zajišťují bezpečnou komunikaci mezi vaší aplikací a službami společnosti Shell.

Ověřování

Poznámka k migraci

Toto API poskytuje koncový bod pro tokeny OAuth ve verzích v1 i v2. Verze 1 je zastaralá a bude odstraněna v rámci nadcházejícího okna změn. Nové integrace by měly používat verzi v2 a stávající uživatelé by měli na verzi v2 přejít co nejdříve. Hlavní rozdíly spočívají ve formátu odpovědi: verze v2 používá standardní názvy polí OAuth (expires_in namísto expires_in(seconds) a Bearer namísto BearerToken).

Autorizační tok

1. Žádost o ID klienta a tajný klíč

Kontaktujte tým Shell API a požádejte o přístup k ověřování OAuth. Tým Shell API vám poskytne ID klienta a tajný klíč.

2. Žádost o token Bearer

Jakmile získáte přihlašovací údaje, odešlete žádost na koncový bod pro OAuth token v API ověřování Shell s vašimi přihlašovacími údaji.

Příklad požadavku:

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 odpovědi obdržíte token typu „Bearer“:

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

Poznámka: Doba platnosti tokenu typu „Bearer“ je uvedena v sekundách.

3. Autorizace požadavků na API

Při volání API Shellu uveďte v hlavičce požadavku následující:

Authorization: Bearer access_token

Základní URL

Integrace jádra

1. Generování tokenu OAuth

Popis: Požádejte o přístupový token OAuth pomocí svých klientských přihlašovacích údajů. API vrátí časově omezený token typu „Bearer“, který musí být zahrnut v hlavičce „Authorization“ všech následujících požadavků na API. Z bezpečnostních důvodů se místo metody GET používá metoda POST, aby se zabránilo ukládání do mezipaměti.

Cesta: POST /v2/oauth/token

Ukázkový požadavek

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'

Parametry požadavku

Ukázková odpověď

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

Parametry odpovědi

Zpracování chyb

API používá standardní stavové kódy HTTP. V případě chyby budou v těle odpovědi uvedeny další podrobnosti.