OAuth 2.0:配置新的 API 代理

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

如果您使用的是 Apigee Cloud 版本的 Edge,您将看到组织中默认包含一个名为 oauth 的代理。此代理提供了两个端点示例,用于生成访问令牌和刷新令牌。如果您想详细了解 OAuth 令牌端点,请参阅了解 OAuth 端点

客户端凭据授权类型定义了签发访问令牌以交换生成应用凭据的过程。这些应用凭据是 Apigee Edge 为组织中注册的每个应用签发的使用方键值和密钥对。如需了解详情,请参阅实现授权代码授权类型

将 OAuth 2.0 添加到新的 API 代理

创建新的 API 代理时,您可以轻松地向 API 添加 OAuth 验证功能。

Edge

如需使用 Edge 界面为 API 添加 OAuth 验证,请执行以下操作:

  1. 登录 apigee.com/edge
  2. 在左侧导航栏中,选择开发 > API 代理
  3. 点击添加代理
  4. 使用“创建代理”向导创建一个反向代理。请参阅构建一个简单的 API 代理
  5. 在向导的通用政策页面上,选择 OAuth v2.0 旁边的单选按钮。

传统 Edge (Private Cloud)

如需使用传统版 Edge 界面为 API 添加 OAuth 验证,请执行以下操作:

  1. 登录 http://ms-ip:9000,其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。
  2. 在顶部导航栏中,依次选择 API > API 代理
  3. 点击 + API 代理
  4. 使用“创建代理”向导创建一个反向代理。请参阅构建简单的 API 代理
  5. 在向导的 Security 页面上,选择 OAuth v2.0 旁边的单选按钮。

选择此选项后,两个政策都将附加到新创建的 API 代理中,一个用于验证访问令牌,另一个用于在验证完成后删除访问令牌。

请注意,发布 API 产品复选框将变为可选中,且会被自动选中。如果您想要在构建新 API 代理时自动生成产品,请选中此复选框。将创建与新 API 代理相关联的自动生成的产品。如果您希望将现有产品与此新 API 相关联,请务必取消选中此复选框,以避免创建不必要的产品。如需了解商品,请参阅什么是 API 产品?

使用默认的 OAuth 代理

Oauth 代理提供以下端点 URI:

/oauth/client_credential/accesstoken

将此 URI 发布至需要获取访问令牌的开发者。应用开发者将其应用配置为调用此端点,并提供其使用方密钥和密文对,以获取访问令牌。

默认客户端凭据令牌端点通过网络在以下网址上公开:

https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken

例如,如果您的单位名称为“apimakers”,则网址为:

https://apimakers-test.apigee.net/oauth/client_credential/accesstoken

这是开发者为获取访问令牌而调用的网址。

调用 API

当您重新获得访问令牌时,可以使用 Authorization 标头和不记名令牌调用 API,如下所示:

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

另请参阅验证访问令牌