本页面适用于 Apigee 和 Apigee Hybrid。
查看 Apigee Edge 文档。
要在 Apigee 上参与 OAuth 2.0 流程,必须注册客户端应用。
什么是注册?
注册后,Apigee(授权服务器)可以唯一标识您的应用。注册应用时,您将收到两个密钥:客户端 ID 和客户端密钥。在与授权服务器协商访问令牌时,应用需要这些密钥。
简要步骤
如需注册新应用,请在应用页面中执行以下操作:
Apigee Cloud 控制台
- 在 Google Cloud 控制台中,前往分发 > 应用页面。
- 点击创建。
- 指定应用详细信息,如下表所述。
字段 说明 是否必需? 应用名称 应用的名称。应用创建后,您将无法更改其名称。此名称用于 Apigee API 调用。 需要 显示名称 Apigee 界面和开发者门户中显示的应用的显示名。 可选 开发者 从下拉列表中选择开发者名称。
注意:出于性能原因,下拉菜单中不会显示所有开发者。首先在搜索框中输入开发者名称或电子邮件地址,同时自动优化下拉值,使其与您输入的文本相匹配。 另请参阅注册应用开发者。
需要 回调网址 通常指定被指定为代表客户端应用接收授权代码的应用的网址。并不是所有 API 产品都要求使用此值。 可选 备注 应用的说明性备注。 可选 - 指定凭据,包括 API 密钥到期时间、状态以及关联的 API 产品。在凭证部分中,点击
字段 说明 到期 选择到期时长或日期,或将 API 密钥设置为永不过期。 产品 将一个或多个 API 产品与 API 密钥相关联: - 点击 添加产品。
- 从列表中选择一个或多个 API 产品。
- 点击确定。
- 点击添加。
添加凭证并输入以下信息:
- 为每个 API 产品将状态设置为已批准或已撤消。如果您向需要手动批准的凭证添加了 API 产品,系统会显示
Pending approval status
。否则,系统会显示Approved
。在此步骤中,您可以更改审批状态。- 在凭证部分的产品列表中,选择一个或多个产品。
- 点击批准或撤消。
- 点击创建。
- 在开发者应用列表中找到新应用,并将其选中。
- 点击 可查看密钥(客户端 ID)和密钥(客户端密钥)值。
经典版界面
- 访问“开发者应用”页面,如下所述。
要访问“开发者应用”页面,请执行以下操作:
- 打开 Apigee 界面。
- 在左侧导航栏中选择发布 > 应用。
- 点击 + 应用
- 填写显示的表单:
- 输入应用的名称和显示名称。
- 选择开发者(您可以选择其中一个默认开发者或创建自己的开发者)。
- (可选)输入回调网址。它适用于“三足式”OAuth 授权类型流程。这是 Apigee 在用户使用资源服务器完成身份验证(登录)后重定向给用户的地方。它必须是一个完整网址,因此您可以输入类似于
https://www.example.com
的内容。如需详细了解三足式 OAuth,请参阅实现授权代码授权类型。 - 添加 API 产品。您可以选择现有产品或创建自己的产品。
- 暂时跳过自定义属性部分。
- 点击创建。
- 在开发者应用列表中找到新应用,并将其选中。
- 点击显示以查看使用方 ID(客户端 ID)和使用方密钥(客户端密钥)值。
更多信息
有关应用注册的详细讨论,请参阅注册应用和管理 API 密钥。如果您想详细了解 API 产品的作用,请参阅什么是 API 产品?。