Apigee API 使用入门

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

Apigee API 可用于通过一组 RESTful 操作以编程方式开发和管理 API。

您可以使用 Apigee API 将 API 代理管理集成到贵组织的软件开发生命周期 (SDLC) 中。Apigee API 的一个常见用途是编写脚本或代码，以部署 API 代理或将 API 代理从一个环境迁移到另一个环境，这也是大型自动化流程的一部分，该流程还部署或迁移其他应用程序。

如需了解详情，请参阅 Apigee API。

启用 Apigee API

确保您已启用 Apigee API。如需为项目启用 API，最简单的方法是使用 Google Cloud 控制台。如需了解完整详情，请参阅第 3 步：启用 API。

Apigee API 支持 OAuth 2.0 进行用户身份验证。借助 OAuth 2.0，您可以将 Google Cloud 凭据交换为访问令牌，以便用于安全地调用 Apigee API。获取令牌后，在令牌失效之前，您不再需要交换凭据。

如需使用 Google Cloud 凭据获取令牌，请执行以下操作：

获取当前活跃账号的令牌：

export TOKEN=$(gcloud auth print-access-token)

调用 Apigee API 时，请在 Authorization 标头中传递访问令牌。例如：

curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"

如需使用服务账号密钥获取授权令牌，请执行以下操作：

使用 GCP Console 为您的服务账号生成密钥，如创建和管理服务账号密钥中所述。
包含您的服务账号凭据的 JSON 文件就会下载到您的计算机。
将 GOOGLE_APPLICATION_CREDENTIALS 环境变量设置为服务账号密钥所在的路径：
```
export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json
```

调用 Apigee API 时，使用 Google Cloud CLI 向授权标头添加访问令牌。例如：

curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)"

文档中提供的 Apigee API 和 gcloud CLI 示例使用下表中定义的一个或多个环境变量。

通过在环境中将环境变量预先设置为有意义的值，您可以复制并粘贴示例请求，然后只需做极少的修改或不做更改，即可在自己的环境中执行它们。

本部分中的示例使用 curl 来演示如何使用 Apigee API 开发应用。curl 是一种开源命令行工具，用于通过网址语法传输数据，支持 HTTP 和 HTTPS 等常见协议。

下表汇总了示例中使用的 curl 命令行选项。

选项	说明
`-d '{}' --data @filename --data-binary @filename`	定义您可以直接传递或通过指定文件名的请求正文。
`-F file=@filename --form file=@filename`	定义可通过指定文件名传递的基于表单的数据。
`-H --header`	定义请求标头。您必须在请求标头中传递以下信息： `Authorization` 标头：用于用户身份验证的 OAuth 2.0 令牌，如获取 OAuth 2.0 访问令牌中所述。 `Content-Type` 标头：使用 API 创建或更新资源（POST、PATCH、PUT）时发送的请求正文的内容类型。
`-X`	指定请求的类型（GET、POST 等）。

例如：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis" \
   -X GET \
   -H "Authorization: Bearer $TOKEN"

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。