Shell Authentication 1.0.1

Permulaan Pantas Pengesahan ShellPendahuluanAPI Pengesahan Shell membolehkan aplikasi rakan kongsi mengesahkan dengan Gateway API menggunakan aliran kelayakan pelanggan OAuth 2.0. API ini menyediakan token akses yang terhad masa yang membenarkan permintaan ke API Shell, memastikan komunikasi selamat antara aplikasi anda dan perkhidmatan Shell.

ManfaatKeterangan

>tr>Persekitaran FleksibelSokongan untuk persekitaran ujian dan pengeluaranPengesahanNota PemindahanAPI ini menyediakan kedua-dua versi v1 dan v2 bagi titik akhir token OAuth. Versi 1 telah ditamatkan dan akan dialih keluar dalam tetingkap perubahan akan datang. Integrasi baharu harus menggunakan v2, dan pengguna sedia ada harus beralih ke v2 secepat mungkin. Perbezaan utama adalah dalam format respons: v2 menggunakan nama medan OAuth piawai (expires_in dan bukannya expires_in(seconds) dan Bearer dan bukannya BearerToken).Aliran kebenaranMinta ID Klien dan RahsiaHubungi Pasukan API Shell untuk memohon akses kepada pengesahan OAuth. Pasukan API Shell akan menyediakan ID Klien dan Rahsia.

Meminta token BearerSetelah anda mendapat kelayakan, buat permintaan kepada puncak hujung OAuth Token API Autentikasi Shell dengan kelayakan anda. Contoh permintaan: `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'Anda akan menerima token Bearer dalam respons:

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

Nota: Masa luput token pemegang disediakan dalam saat.


Benarkan permintaan APIApabila memanggil Shell API, sertakan yang berikut dalam pengepala permintaan.

Authorization: Bearer access_token"

URL Asas

Akses SelamatStandard OAuth 2.0 dengan token terhad masa

PersekitaranURLUjihttps://api-test.shell.comProductionhttps://api.shell.com

Penyepaduan Teras1. Jana Token OAuthKeterangan: Meminta token akses OAuth menggunakan kelayakan klien anda. API ini akan mengembalikan token Bearer yang terhad masa yang mesti disertakan dalam header Autentikasi bagi semua permintaan API seterusnya. Untuk langkah keselamatan, kaedah POST digunakan bukannya GET bagi mengelakkan pengeksesan.Laluan: POST /v2/oauth/tokenPermintaan Contoh

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'

Parameter Permintaan

ParameterJenisDiperlukanKeterangan

grant_typestringYaNilai jenis pemberian untuk akses (gunakan "client_credentials")

Tindak Balas Contoh

{
  "access_token": "NiE3gzPNVFpwYYMyyWu6mGFYtKN5",
  "expires_in": "899",
  "token_type": "Bearer"
}```  Parameter Respons  ParameterJenisKeteranganaccess_tokenstringToken Akses yang dijana untuk digunakan dalam permintaan APIexpires_instringTempoh luput dalam saattoken_typestringJenis Token (Pemegang)Pengendalian RalatAPI ini menggunakan kod status HTTP piawai. Sekiranya berlaku ralat, butiran tambahan akan disediakan dalam badan respons.Kod RalatKeteranganPenyelesaian400Permintaan Tidak Sah - Permintaan mengandungi sintaks yang salah atau tidak dapat dipenuhiSemak bahawa semua parameter yang diperlukan disertakan dan diformat dengan betul401ID Klien Tidak Sah - Header Autentikasi hilang atau maklumat log masuk tidak sahSemak client_id dan client_secret anda adalah betul dan disulitkan dengan betul403Dilarang - Klien tidak mempunyai hak aksesHubungi Pasukan API Shell untuk mengesahkan kebenaran akses anda404Tidak Ditemui - Tidak dapat mengenal pasti proksi untuk URL yang dimintaSemak URL hujung adalah betul untuk persekitaran anda405Kaedah Tidak DibenarkanSemak semula kebenaran akses anda dengan Pasukan API Shell406Tidak DitemuiPastikan anda menggunakan kaedah POST untuk hujung token500Ralat Pelayan DalamanTidak dapat mengenal pasti proksi untuk URL yang dimintaSemak URL hujung adalah betul untuk persekitaran anda407Kaedah Tidak DibenarkanSemak semula kebenaran akses anda dengan Pasukan API Shell408Tamat MasaSemak semula kebenaran akses anda dengan Pasukan API Shell409Kesalahan HujungSemak semula k'tempatan URL hujung untuk persekitaran anda - Kaedah HTTP tidak disokong untuk sumber iniPastikan anda menggunakan kaedah POST untuk hujung token500Ralat Pelayan Dalaman - Pelaksanaan gagal di pelayanUlang permintaan; hubungi Sokongan Shell jika masalah berterusan

client_idstringYaID Klien yang disediakan oleh Shell
client_secretstringYaRahsia Klien yang disediakan oleh Shell