BarTender Cloud REST API 傳統驗證方式
概述
先前版本的 BarTender Cloud 使用 OAuth 2.0 搭配 Open ID Connect (OIDC) 來讓網頁應用程式存取 BarTender Cloud Rest API。OAuth 是一種驗證機制,允許服務與第三方網頁應用程式共享資料,作為直接分享登入憑證及其相關安全風險的替代方案。OIDC 則是在 OAuth 2.0 架構上運作的開放式驗證協議。
雖然 BarTender Cloud 的進階身分提供者現在已支援內部驗證,本篇文章將詳細說明舊版 OAuth 驗證的運作方式。由於這是進階主題,本指南主要針對具備技術背景的人士。
適用對象
BarTender Cloud REST API
資訊
網頁應用程式註冊流程
請前往 管理 > API 金鑰 > 註冊應用程式以取得 OAuth 存取權限,在 BarTender Cloud 中註冊您的網頁應用程式。
請在相應欄位填寫名稱與描述。其餘欄位的需求如下:
- 登入 URI:您網頁應用程式中的授權端點,用於將使用者重新導向。如需更多關於重新導向的資訊,請點選這裡。
- 回呼清單:您網頁應用程式中的 URL 清單,BarTender Cloud 在驗證後會將回應傳送到這些網址。
- 登出網址:您網頁應用程式中的端點,使用者登出後會被導向這些網址。
- 允許的來源(CORS):雖然不建議,但跨來源驗證可讓您直接在應用程式中嵌入登入表單。若需要嵌入式登入,應用程式必須設定跨來源資源共享(CORS)。如需更多 CORS 資訊,請點選這裡。
- 允許的網頁來源:可進行跨來源驗證的 URL。如需更多跨來源驗證資訊,請點選這裡。
更多註冊參數的資訊,請參閱說明文件中的 網頁應用程式 > 註冊 BarTender Cloud 網頁應用程式。
OAuth 驗證流程
簡單來說,OAuth 讓您可以授權第三方服務以您的名義存取 BarTender Cloud 內容,而無需將密碼提供給該服務。這是網頁應用程式存取 BarTender Cloud Rest API 時所使用的驗證流程。
OAuth 技術細節
BarTender Cloud 使用 OAuth 提供者 Auth0 來處理驗證流程,第三方網頁應用程式必須透過其 API 與 BarTender Cloud 進行驗證。
BarTender Cloud 採用 Auth0 的授權碼流程來進行網頁應用程式授權,同時也提供資源擁有者密碼流程給受信任的應用程式使用。
OAuth 授權碼流程
以下說明當您透過第三方網頁應用程式(Client)驗證以存取您的 BarTender Cloud 租戶空間時的應用程式流程:
-
在應用程式中選擇 登入。
-
Auth0 的 SDK 會將您重新導向至授權伺服器。相關網址如下:
-
BarTender Cloud 美洲與亞太區環境:https://bartendercloud-production.us.auth0.com/authorize
- BarTender Cloud 歐洲、中東與非洲區環境:https://bartendercloud-production.eu.auth0.com/authorize
-
-
授權伺服器會導向登入與授權提示畫面。
-
使用已設定的登入選項進行驗證。您可能會看到一個同意授權的提示,列出將授權給應用程式的權限。
- 授權伺服器會帶著一次性授權碼將您導回應用程式。
-
授權伺服器會驗證授權碼、應用程式/Client ID 及應用程式/Client secret。
- BarTender Cloud 美洲與亞太區環境:https://bartendercloud-production.us.auth0.com/oauth/token
- BarTender Cloud 歐洲、中東與非洲區環境:https://bartendercloud-production.eu.auth0.com/oauth/token
- 應用程式/Client ID 用於識別您的應用程式-於 BarTender Cloud 註冊應用程式時產生
- 應用程式/Client secret 用於證明 ClientID 的擁有權-於 BarTender Cloud 註冊應用程式時產生
-
授權伺服器會回傳 ID token 與 access token(以及選擇性的 refresh token)。
-
應用程式可使用 access token 呼叫 API(Audience 參數指定的 API),以存取 BarTender Cloud 的資料與功能,範圍由 Scope 決定。
- Audience 表示您要存取的特定 API 端點。
-
API 會回傳所要求的資料。
Auth0 API
您可以參考網頁應用程式快速入門指南,了解如何在您的應用程式中整合 Auth0 API。
其他資源
說明文件:
支援文章:
其他外部資源 (版權所有):