使用 API 购买和管理 API 产品订阅

本页面适用于 ApigeeApigee Hybrid

查看 Apigee Edge 文档。

如果您希望构建自己的自定义门户或手动管理购买流程,以下几个部分介绍如何使用 API 购买和管理 API 产品订阅。另请参阅在 Drupal 开发者门户中集成 Apigee Monetization

使用 API 购买 API 产品订阅

如需购买 API 产品订阅,请向以下 API 发出 POST 请求:https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

请按照资源:订阅中所述,在请求正文中传递必填字段,配置 API 产品订阅请求。

例如,以下 API 调用可为指定开发者购买对 HelloworldProduct API 产品的订阅:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{"apiproduct":"HelloworldProduct"}'

按照获取 OAuth 2.0 访问令牌中的说明,将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项,请参阅使用 curl。如需了解所使用的环境变量,请参阅为 Apigee API 请求设置环境变量

以下提供了一个响应输出示例。startTime 设置为当前时间。

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

如需了解详情,请参阅 Purchase API Product Subscription API

使 API 产品订阅立即到期

如需立即使 API 产品订阅到期,请向以下 API 发出 POST 请求:https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION:expire

例如,以下 API 调用将使指定开发者名为 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 的 API 产品订阅到期:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72:expire" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

按照获取 OAuth 2.0 访问令牌中的说明,将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项,请参阅使用 curl。如需了解所使用的环境变量,请参阅为 Apigee API 请求设置环境变量

以下提供了一个响应输出示例。endTime 设置为当前时间。

{
  "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
  "apiproduct": "WeatherReport",
  "startTime": "1613494852000",
  "endTime" : "1617894954000",
  "createdAt": "1613494852000",
  "lastModifiedAt": "1613494852000"
}

列出开发者的所有 API 产品订阅

如需列出开发者的所有 API 产品订阅,请向以下 API 发出 GET 请求:https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

您还可以选择传递以下字段以支持分页:

  • startKey,用于指定要从中开始显示订阅列表的 API 产品订阅的名称。如果省略,则列表会从第一个项目开始。与 count 配合使用以提供更有针对性的过滤。例如,如需查看 51-150 中的 API 产品订阅,请将 startKey 的值设置为第 51 个订阅的名称,并将 count 的值设置为 100。
  • count,用于指定要在 API 调用中返回的费率方案数量。与 startKey 配合使用以提供更有针对性的过滤。上限为 1000。默认值为 100。

例如,以下 API 调用将列出指定开发者的所有 API 产品订阅:

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

按照获取 OAuth 2.0 访问令牌中的说明,将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项,请参阅使用 curl。如需了解所使用的环境变量,请参阅为 Apigee API 请求设置环境变量

以下提供了一个响应输出示例:

{
  "developerSubscriptions": [
    {
      "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
      "apiproduct": "HelloworldProduct",
      "startTime": "1615987132000",
      "createdAt": "1615903252000",
      "lastModifiedAt": "1615903252000"
    },
    {
      "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
      "apiproduct": "WeatherReport",
      "startTime": "1614124552000",
      "createdAt": "1613494852000",
      "lastModifiedAt": "1613494852000"
    }
  ]
}

如需了解详情,请参阅 List API Product Subscriptions API

查看有关 API 产品订阅的详细信息

如需查看有关开发者的 API 产品订阅的详细信息,请向以下 API 发出 GET 请求:https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION

例如,以下 API 调用将列出指定开发者的所有 API 产品订阅:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

按照获取 OAuth 2.0 访问令牌中的说明,将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项,请参阅使用 curl。如需了解所使用的环境变量,请参阅为 Apigee API 请求设置环境变量

以下提供了一个响应输出示例:

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

如需了解详情,请参阅 Get API Product Subscription API