BarTender Cloud REST API 传统身份验证
概述
早期版本的 BarTender Cloud 使用 OAuth 2.0 结合 Open ID Connect (OIDC) 进行 Web 应用程序的身份验证,以访问 BarTender Cloud Rest API。OAuth 是一种身份验证机制,允许服务与第三方 Web 应用共享数据,作为共享登录凭据及其带来的安全风险的替代方案。OIDC 是一种基于 OAuth 2.0 框架的开放身份验证协议。
虽然 BarTender Cloud 的增强型身份提供程序现在支持内部身份验证,但本文将详细介绍传统 OAuth 身份验证的工作原理。由于这是一个高级主题,本指南面向具备技术背景的用户。
适用范围
BarTender Cloud REST API
信息
Web 应用注册流程
在 BarTender Cloud 中注册您的 Web 应用,请前往 管理 > API 密钥 > 注册应用以获取 OAuth 访问权限。
在相应字段填写名称和描述。其余字段的要求如下:
- 登录 URI:Web 应用中的授权端点,用户将被重定向到此处。关于重定向的更多信息请点击这里。
- 回调列表:Web 应用中的 URL 列表,BarTender Cloud 在身份验证后会将响应发送到这些地址。
- 登出 URL:Web 应用中的端点,用户登出后会被重定向到这些地址。
- 允许的来源(CORS):虽然不推荐,但跨域身份验证允许直接在应用中嵌入登录表单。如果需要嵌入式登录,应用必须设置跨域资源共享(CORS)。关于 CORS 的更多信息请点击这里。
- 允许的 Web 来源:可进行跨域身份验证的 URL。关于跨域身份验证的更多信息请点击这里。
关于注册参数的更多信息,请参阅帮助文档中的 Web 应用 > 在 BarTender Cloud 中注册 Web 应用。
OAuth 身份验证流程
简单来说,OAuth 允许您授权第三方服务以您的名义访问 BarTender Cloud 内容,而无需向该服务透露您的密码。这是 Web 应用访问 BarTender Cloud Rest API 时使用的身份验证流程。
OAuth 技术细节
BarTender Cloud 使用 OAuth 提供商 Auth0 处理身份验证流程,第三方 Web 应用需通过其 API 与 BarTender Cloud 进行身份验证。
BarTender Cloud 对 Web 应用授权采用 Auth0 的授权码流程,同时也为受信任的应用提供资源所有者密码流程。
OAuth 授权码流程
以下是通过第三方 Web 应用(客户端)尝试与 BarTender Cloud 进行身份验证以访问您的租户空间时的详细流程:
-
在应用内选择 登录 。
-
Auth0 的 SDK 会将您重定向到授权服务器。相关 URL 如下:
-
BarTender Cloud 美洲和亚太环境:https://bartendercloud-production.us.auth0.com/authorize
- BarTender Cloud EMEA 环境:https://bartendercloud-production.eu.auth0.com/authorize
-
-
授权服务器会重定向到登录和授权提示页面。
-
使用已配置的登录选项进行身份验证。您可能会看到一个权限授权提示,列出将授予应用的权限。
- 授权服务器会将一次性授权码重定向回应用。
-
授权服务器会验证授权码、应用/客户端 ID 以及应用/客户端密钥。
- BarTender Cloud 美洲和亚太环境:https://bartendercloud-production.us.auth0.com/oauth/token
- BarTender Cloud EMEA 环境:https://bartendercloud-production.eu.auth0.com/oauth/token
- 应用/客户端 ID 用于识别您的应用 —— 在 BarTender Cloud 注册应用时生成
- 应用/客户端密钥用于证明对 ClientID 的所有权 ——在 BarTender Cloud 注册应用时生成
-
授权服务器返回 ID 令牌和访问令牌(可选返回刷新令牌)。
-
应用可使用访问令牌调用 API(Audience 参数指定的 API),以访问 BarTender Cloud 的数据和功能,权限范围由 Scope 决定。
- Audience 表示您要访问的具体 API 端点。
-
API 返回所请求的数据。
Auth0 API
您可以参考 Web 应用快速入门指南,了解如何在您的应用中集成 Auth0 API。
其他资源
帮助文档:
支持文章:
其他外部资源 (版权所有):