Azure API 管理如何支持盈利

适用于:所有 API 管理层级

使用 Azure API 管理服务平台,可以:

  • 发布供使用者订阅的 API。
  • 去风险实现。
  • 加快项目进度。
  • 自信地扩展您的 API。

本文档重点介绍支持实现盈利策略的 API 管理功能,例如提供一种无摩擦的体验:

  • 探索您的公共 API。
  • 输入付款详细信息。
  • 激活订阅。
  • 使用 API。
  • 监视使用情况。
  • 自动支付 API 的使用费用。

下图介绍了以下关键 API 管理功能:

关键 API 管理盈利功能的示意图。

API 发现

使用 API 管理的内置开发人员门户启动 API 并载入 API 使用者。 强调开发人员门户的良好质量开发内容,使 API 使用者能够无缝浏览和使用 API。 测试提供的内容和信息是否具备可访问性、完整性和可用性。

若要了解如何添加内容并控制开发人员门户的品牌,请参阅 开发人员门户概述

API 打包

使用 API 管理,可以使用产品和策略的概念来管理 API 的打包和呈现方式。

Products

API 通过 产品发布。 产品允许你定义:

  • 订阅者可以访问哪些 API。
  • 特定的限制策略,例如将特定订阅限制为每月调用次数的配额。

当 API 使用者订阅产品时,他们会收到可用于进行调用的 API 密钥。 最初,订阅设置为状态 submitted 。 激活订阅以允许订阅者使用 API。

可以配置 API 管理产品,以将底层 API 打包成镜像您的收入模型,并采用:

  • 收入模型中每个层之间的一对一关系。
  • 相应的 API 管理产品。

示例项目使用 API 管理产品作为编码货币化策略的顶级手段。 API 管理产品镜像收入模型层,并为每个层的特定定价模型编制索引。 此设置提供了一种高度灵活的、配置驱动的方法来准备盈利策略。

Policies

应用 API 管理策略来控制每个产品的服务质量。 示例项目使用两个特定的策略功能来控制服务质量,这与收入模型一致:

策略功能 Description
配额 定义用户可以在指定时间段内对 API 发出的调用总数,例如 ,每月 100 次调用。 用户达到配额后,对 API 的调用将失败,调用方会收到 403 Forbidden 响应状态代码。
速率限制 定义在滑动时间范围内对 API 进行的调用数,例如 ,每分钟 200 次调用。 旨在防止 API 使用量激增,超出所选产品的付费服务质量。 超过呼叫速率后,调用方会收到 429 Too Many Requests 响应状态代码。

有关策略的更多详细信息,请参阅 Azure API 管理中的策略

API 消耗

使用 API 订阅,通过产品为 API 消费者授予对您的 API 的访问权限。

  1. 注册特定 API 管理产品时,API 使用者会建立 API 订阅。
  2. 使用 API 管理委托将订阅过程与支付提供商集成。
  3. 成功提供付款详细信息后,用户通过为订阅生成的唯一安全密钥获取对 API 的访问权限。

有关订阅的详细信息,请参阅 Azure API 管理中的订阅

API 使用情况监视

可以使用 API 管理的内置分析来获取有关 API 使用情况和性能的见解。 这些分析通过以下方式提供报告:

  • API
  • 地理
  • API 操作
  • 产品
  • 请求
  • Subscription
  • Time
  • 用户

定期查看分析报告,了解 API 使用者如何采用盈利策略。

有关详细信息,请参阅 监视 API 管理

安全性

使用 API 管理的产品、API 策略和订阅控制每个用户的访问级别。 如果用户已成功向付款提供商进行身份验证,则通过授予订阅级 API 访问权限来防止滥用和滥用,即使特定 API 产品是免费的。

整合

通过 API 管理和所选支付提供商之间的前端和后端集成,创建无缝盈利体验。 使用 API 管理委派进行前端集成,使用 REST API 进行后端集成。

代表团

在示例项目中,可以使用 API 管理委派 与合作伙伴支付提供商进行自定义集成。 演示使用委派进行注册/登录和产品订阅体验。

注册/登录工作流

  1. 开发人员在 API 管理开发人员门户中选择登录或注册链接。
  2. 浏览器将重定向到委派终结点(配置为自定义计费门户应用中的页面)。
  3. 自定义计费门户应用提供登录/注册 UI。
  4. 成功登录/注册后,用户将进行身份验证并重定向回起始 API 管理开发人员门户页面。

产品订阅工作流

  1. 开发人员在 API 管理开发人员门户中选择产品,然后选择“ 订阅 ”按钮。
  2. 浏览器将重定向到委派终结点(配置为自定义计费门户应用中的页面)。
  3. 自定义计费门户应用:
    • 显示基于付款提供商(Stripe 或 Adyen)配置的 UI。
    • 引导用户完成相关结帐过程。
  4. 用户重定向回起始 API 管理产品页。
    • 该产品处于活动状态,API 密钥可用。

REST API

使用 REST API 进行 API 管理,以自动化您的盈利策略操作。

示例项目使用 API 以编程方式:

  • 检索 API 管理产品和策略,以在支付提供商(如 Stripe)中启用类似概念的同步配置。
  • 定期轮询 API 管理,以检索每个订阅的 API 使用情况指标并推动计费过程。

有关详细信息,请参阅 Azure API 管理 REST API 参考

DevOps

使用 Azure 资源管理器实现版本控制并自动执行 API 管理的部署更改,包括配置实现盈利策略的功能,例如:

  • Products
  • Policies
  • 开发人员门户

在示例项目中,Azure 资源管理器脚本通过 JSON 文件进行扩充,该文件定义每个 API 管理产品的定价模型。 通过此扩充,可以在 API 管理与所选的支付提供商之间同步配置。 整个解决方案在单个源代码管理存储库下进行管理,以便:

  • 将与正在进行的货币化策略演变相关的所有更改协调为单个版本。
  • 按照治理和审核要求执行更改。

初始化和部署

可以通过以下任一方式部署 API 管理: