通过要求 API 密钥保护 API

请务必保护您的 API 免遭未经授权的访问。要想可以通过 API 密钥（也称为公钥、密钥或应用密钥）。

当应用向您的 API，应用必须提供有效的密钥。在运行时，“Verify API Key”政策检查所提供的 API 密钥：

有效
尚未撤消
与公开所请求 API 产品的 API 密钥相匹配资源

如果密钥有效，则允许请求。如果密钥无效，请求会导致授权失败。

在本教程中，您将创建一个需要有效 API 的 API 代理访问该菜单。

所需条件

Apigee Edge 账号。如果您还没有账号，可以注册其中包含 <ph type="x-smartling-placeholder"></ph> 创建 Apigee Edge 账号。
用于进行 API 调用的网络浏览器。
（对于额外赠金部分，无需提供） cURL 已安装从命令行进行 API 调用。

创建 API 代理

转到 https://apigee.com/edge 并登录。
点击您在顶部导航栏顶部显示用户个人资料菜单，然后从列表中选择该组织
点击着陆页上的 API 代理以显示 API 代理列表。
点击 + Proxy。
在创建代理页面上，选择反向代理（最常用）。

在代理详细信息页面上，按以下方式配置代理：

在此字段中	执行该操作
代理名称	输入：`helloworld_apikey`
项目基本路径	更改为：`/helloapikey` 项目基本路径是向 API 代理发送的请求注意：如需查看 Apigee 关于 API 版本控制的建议，参见 Web API 设计：缺失的中的版本控制链接电子书。
现有 API	输入：`http://mocktarget.apigee.net` 定义 Apigee Edge 在向 API 代理发送的请求
说明	输入：`hello world protected by API key`

点击下一步。
在常用政策页面上的安全性：授权，选择 API 密钥，然后点击下一步。这个将向你的 API 代理添加两项政策
在 Virtual Hosts（虚拟主机）页面上，选择 default（默认）和 secure，然后点击 Next。选择默认允许使用 http:// 调用 API。选择 secure（安全）可让您使用 https:// 调用 API。
在摘要页面上，确保测试部署选择环境，然后点击创建和部署。
您将看到一条确认消息，表明您的新 API 代理和 API 已成功创建产品，并且 API 代理已部署到测试环境
点击修改代理以显示概览 API 代理。

查看政策

在 API 代理编辑器中，点击开发标签页。您会看到 API 代理的请求流中添加了两项政策： <ph type="x-smartling-placeholder">
- 验证 API 密钥：检查 API 调用以确保有效的存在 API 密钥（作为查询参数发送）。
- 移除查询参数 apikey：指定在 API 密钥经过检查后移除该密钥，以免其无谓地暴露在外
点击流程视图中的“Verify API Key 政策”图标，然后查看此政策的 XML 配置。通过 <APIKey> 元素用于告知政策应在何处运行在进行调用时查找 API 密钥。默认情况下，它会查找键作为 HTTP 中名为 apikey 的查询参数请求：
```
<APIKey ref="request.queryparam.apikey" />
```
apikey 是任意名称，可以是任意属性包含该 API 密钥的 ID。

尝试调用 API

在此步骤中，您将直接对目标您将对 API 代理进行失败的调用但受到相关政策的保护

成功

在网络浏览器中，转到以下地址。这是 API 代理配置为转发的目标服务但现在您会直接点击它：
```
http://mocktarget.apigee.net
```
您应该成功收到以下响应：Hello, Guest!
失败

现在尝试调用您的 API 代理：
```
http://ORG_NAME-test.apigee.net/helloapikey
```
将 ORG_NAME 替换为您的边缘组织。

如果没有“验证 API 密钥”政策，此调用将为您提供相同的与上一个调用相同。但在这种情况下，您应该获得以下错误响应：
```
{"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}
```
这意味着您并未传递有效的 API 密钥（如查询参数）。

在接下来的步骤中，您将添加 API 产品。

添加 API 产品

如需使用 Apigee 界面添加 API 产品，请执行以下操作：

选择发布 > API 产品 (API Products)。
点击 +API 产品。

为您的 API 产品输入商品详情。

字段	说明
名称	API 产品的内部名称。错误做法在名称中指定特殊字符。注意：一旦 API 产品创建完毕，您便无法修改该名称。对于示例 `helloworld_apikey-Product`。
显示名称	API 产品的显示名。显示名称用于也可以随时进行修改如果未指定，则将使用名称值。此字段使用名称值；您可以修改或删除其内容显示屏名称可以包含特殊字符。例如： `helloworld_apikey-Product`。
说明	API 产品的说明。例如 `Test product for tutorial`。
环境	API 产品允许访问的环境。例如，`test` 或 `prod`。
访问权限	选择公开。
自动批准访问请求	为此 API 启用密钥请求的自动批准功能从任何应用获取商品。
配额	在本教程中忽略。
允许的 OAuth 范围	在本教程中忽略。

在“API 资源”部分中，选择您刚刚创建。例如 helloworld_apikey。
点击添加。
在路径部分中，添加路径“/”。
点击添加。
点击保存。

在接下来的步骤中，您将获得所需的 API 密钥。

将开发者和应用添加到您的组织

接下来，我们将模拟开发者注册使用您的 API。开发者将拥有一个或多个调用您的 API 的应用，每个应用都会获得一个唯一的 API 密钥这为 API 提供商提供了可以更精确地控制对 API 的访问权限，还可以生成更精细的报告 API 流量（按应用）。

创建一个开发者

如需创建开发者，请执行以下操作：

在菜单中选择 Publish > Developers。
点击 + 开发者。

在“新建开发者”窗口中输入以下内容：

在此字段中	进入
First Name（名字）	`Keyser`
姓氏	`Soze`
用户名	`keyser`
电子邮件	`keyser@example.com`

点击创建。

注册一个应用

如需注册开发者应用，请执行以下操作：

选择发布 > 应用。
点击 + 应用。

在 New App 窗口中输入以下内容：

下午

在此字段中	执行该操作
名称和显示名	输入：`keyser_app`
公司/开发者	选择：`Developer`
开发者	选择：`Keyser Soze (keyser@example.com)`
回调网址和备注	留空

在凭据部分，选择从不过期菜单。此应用的凭据永不会过期。
在产品下，点击添加产品。
选择 helloworld_apikey-Product。
点击添加。
点击应用详情上方和右侧的创建部分，保存您的工作。

获取 API 密钥

如需获取 API 密钥，请执行以下操作：

在应用页面（发布 > 应用），点击 keyser_app。
在 keyser_app 页面上，点击 Key 旁边的 Show 在凭据部分。在产品部分中，请注意，该密钥与 helloworld_apikey 相关联，
，了解所有最新动态。
选择并复制密钥。您将在下一步中用到它。

使用密钥调用 API

您拥有 API 密钥后，就可以使用它来调用 API 代理了。进入在您的网络浏览器中执行以下操作。请替换您的 Edge 组织名称（针对 ORG_NAME）以及下方 API_KEY 的 API 密钥。请确保查询参数中没有多余的空格。

http://ORG_NAME-test.apigee.net/helloapikey?apikey=API_KEY

现在，当您调用 API 代理时，应该会收到以下响应： Hello, Guest!

恭喜！您已创建 API 代理，并通过以下方式保护该代理：要求在调用中包含有效的 API 密钥。

请注意，一般而言，将 API 密钥作为查询参数。您应该考虑 <ph type="x-smartling-placeholder"></ph> 而是改为在 HTTP 标头中传递它。

最佳做法：在 HTTP 标头中传递密钥

在此步骤中，您将修改代理以在名为 x-apikey 的文件。

修改 API 代理。选择开发 >API 代理 > helloworld_apikey，然后转到开发视图。
选择 Verify API Key 政策，并修改政策 XML 以指示在 header 而不是 queryparam:
```
<APIKey ref="request.header.x-apikey"/>
```
保存 API 代理以部署更改。
使用 c网址进行以下 API 调用，将 API 密钥作为名为 x-apikey 的文件。别忘了将组织名称。
```
curl -v -H "x-apikey: API_KEY" http://ORG_NAME-test.apigee.net/helloapikey
```

请注意，要完全完成更改，您还需要配置 AssignMessage 政策移除标头，而非查询参数。例如：

<Remove>
<Headers>
    <Header name="x-apikey"/>
</Headers>
</Remove>