教程：如何实现 API 产品货币化

本教程将向您展示如何为API产品定义定价方案，以及API消费者如何在开发者门户中订阅该货币化产品。

在开始之前

要完成本教程，您必须具备以下先决条件：

关于本教程

IBM® API Connect 包括订阅计费功能，允许API提供商在其API产品中定义定价计划，并通过API产品获利。 如果产品包含定价计划，那么 API 使用者必须将其支付信息输入到 Developer Portal 中，然后才能预订该计划。 API Connect 支持与Stripe Subscription Billing集成，后者是一项独立的云服务，用于管理货币化产品计划、客户、其支付信息以及订阅历史，以便生成月度发票并自动向客户收费。 通过此集成，Stripe 将充当预订计费系统和支付处理系统。

在本教程中，您将完成以下活动：
  1. 设置您的账单资源
  2. 配置 stripe-test 目录
  3. 在开发者门户中启用Stripe支付方式
  4. 创建并发布货币化产品
  5. 在 Stripe 账户中验证发布
  6. 在开发者门户中查看已货币化的产品

设置您的账单资源

通过完成以下步骤，为提供者组织创建 Stripe 计费集成资源。

  1. 登录 API 管理器。
  2. 在主页上，单击 " 管理资源 "磁贴。
    管理资源
  3. 在 " 资源 "页面上执行以下任务。
    1. 在左侧面板中，选择计费。
    2. 在右侧面板中，单击 " 添加 "。
      账单资源页面

      显示用于Stripe集成的添加账单集成页面。

  4. 在添加计费集成页面，执行以下任务。
    1. 在标题字段中，输入账单集成标题。 例如，My Stripe Billing。
      注意： 名称字段将根据您输入的标题自动填写。
    2. 在可发布密钥字段中，输入 Stripe 账户的测试密钥。
    3. 在密钥字段中，输入 Stripe 账户的测试密钥。
      提示： 如果您没有 Stripe 账户，可在此处创建一个： https://dashboard.stripe.com/register. 查看 Stripe 面板，获取测试 API 密钥。 更多信息，请参见 https://dashboard.stripe.com/apikeys.
      注意： 每个Stripe账户都有两套API密钥，一套用于测试，另一套用于生产。 每组 API 密钥针对 Stripe 对象具有不同的名称空间。 测试 API 密钥无法查看由生产 API 密钥创建的对象，反之亦然。 您不能将一个账单集成的 API 密钥与另一个账户的密钥进行切换，也不能将测试密钥和生产密钥进行交换，因为这样会阻止 API Connect 解析使用旧密钥创建的 Stripe 对象。 对于本教程，应使用 Stripe 测试 API 密钥。
    条纹整合页面
  5. 单击添加以创建 Stripe 计费集成资源。 My Stripe Billing 集成现在显示为计费资源。
    我的Stripe账单集成显示为账单资源

配置 stripe-test 目录

为了能够发布货币化产品计划，您必须将计费集成资源添加到目录中。 在此活动期间，您将创建一个名为 stripe-test 的新目录，以便可以在本教程结束时根据需要删除该目录。

  1. 在 API 管理器中，单击侧导航栏中的 在API管理器UI导航窗格中管理图标 管理图标。
  2. 单击添加 > 创建目录 ，创建名为 stripe-test 的新目录。
  3. 单击 stripe-test 目录磁贴，然后单击目录设置选项卡。 选择网关服务 ，并确保目录配置为使用 DataPower® Gateway (v5 compatible) 或 DataPower API Gateway ，或同时使用这两个邮箱。 然后选择 “门户 ”，创建一个开发者门户。 如果不确定如何配置这些设置，请参阅创建和配置目录。
  4. 要将计费集成资源添加到目录中，请选择 “计费 ”，然后点击 “编辑 ”。
    目录账单视图
  5. 选择先前创建的 My Stripe Billing 资源，然后单击保存。
    选择我的条纹账单
    我的Stripe账单现在被列为stripe-test目录的账单整合资源。
    显示我的条纹账单的目录账单视图

在开发者门户中启用Stripe支付方式

为了使 API 用户能够订阅付费计划的产品，您必须在开发者门户中为 stripe-test 目录配置 Stripe 支付方式。

  1. 以管理员身份登录开发者门户。
  2. 如果不显示管理员仪表板，请单击管理以显示。
  3. 在管理员仪表板中，点击扩展。 这样会打开“扩展”页面的“列表”选项卡，并且显示已安装模块的列表。
  4. 在搜索过滤器中输入 Stripe，选择 APIC 货币化 Stripe 集成，然后单击启用。
    安装APIC货币化Stripe集成模块的屏幕
    APIC Monetization Stripe Integration模块的默认设置现已启用，您需要编辑这些设置。
  5. 单击配置 > 系统 > IBM API Connect 计费。
  6. 将计费提供者模块映射下拉选项更改为新启用的 APIC 货币化 Stripe 集成 (ibm_stripe_payment_method)，然后单击保存配置。
    APIC Monetization Stripe Integration模块的模块映射屏幕
  7. 单击配置 > 系统 > IBM APIC Stripe 集成 ，然后输入您在设置计费资源的第 4 步中为 My Stripe Billing 集成资源输入的相同 Stripe 测试 API 凭据。 然后点击保存配置。
    设置条纹API密钥
    现在， 开发者门户中已配置条纹付款方式。

创建并发布货币化产品

创建包含定价计划的产品，并将其发布到开发者门户。

  1. 首先，需要下载测试 API 以与产品配合使用：
    • 如果您的条纹测试目录使用了 DataPower Gateway (v5 compatible) ，请将 findbranch.txt 文件下载到本地文件系统。 将此文件重命名为 findbranch.yaml。
    • 如果您的条纹测试目录使用了 DataPower API Gateway ，请将 findbranch_v6.txt 文件下载到本地文件系统。 将此文件重命名为 findbranch.yaml。
    或者，如果您愿意，可以使用自己的 API 之一。
  2. 要将 API 导入 API 管理器 ，请单击侧导航栏中的 在API管理器UI导航窗格中开发图标 Develop 图标，然后单击 Add > API（从 REST、 GraphQL 或 SOAP）。
    添加API屏幕
  3. 确保 OpenAPI 2.0 ，然后从导入部分选择现有 OpenAPI ，并点击下一步。
    现有 OpenAPI 选项
  4. 单击将文件拖放到此处或单击以上载，并选择本地文件系统上的 findbranch.yaml 文件以上载该文件。 然后，单击下一步。
    验证文件已准备就绪，可以导入
  5. 保持取消选中“激活 API”，因为稍后在此部分中发布货币化产品时将激活 API。 单击下一步以继续。
  6. 这样会显示“摘要”页面，表明已生成 API 定义。
    摘要页面显示 OpenAPI 2.0 的定义已导入
  7. 单击编辑 API 查看生成的 API 定义，然后单击侧导航栏中的 在API管理器UI导航窗格中开发图标 Develop 图标继续创建货币化产品。 API FindBranch API 现在应显示在 API 列表中，如果没有，只需点击 刷新 API 管理器用户界面导航窗格中的图标 Refresh 图标刷新浏览器即可。
  8. 单击添加 > 产品
    开发页面，显示 FindBranch API
  9. 选择新产品 ，然后点击下一步。
  10. 在标题栏中输入 FindBranches ，然后点击下一步。
    创建新的产品信息页面
  11. 选择导入的 FindBranch API 或您自己的 API，然后单击下一步。
  12. 接受默认的计划 ，然后点击下一步。 您稍后添加定价计划。
    创建新产品默认计划页面
  13. 接受发布 、可见性和可订阅性的默认设置，并点击下一步。
    创建新产品 默认发布页面
  14. 这样会显示“摘要”页面，确认已创建新产品。
    创建新产品摘要页面
  15. 单击编辑产品以继续配置。
  16. 选择 “设计”选项卡后，点击导航菜单中的 “平面图”。
    FindBranches 产品计划页面
  17. 在“计费集成”部分中，选择 my-stripe-billing 作为计费集成资源。
  18. 在“计划”部分中，单击添加以创建包含定价的新计划。
  19. 输入新计划的标题，例如 Gold，但是保持取消选中核准复选框。
  20. 将切换开关切换到 “计划定价” 即可显示计划定价定义部分。
  21. 选择包含免费试用天数，并将订户可以免费使用计划的试用天数保持缺省值 1，之后将开始其计费周期。
  22. 同样， 货币的默认值仍为 USD - US Dollar ， 每月费用的默认值仍为 10 ，以便向订户收取费用。
    创建计划和计划定价部分
  23. 在“计划速率限制”部分中，将调用数更改为每小时 1000，以将此计划与缺省计划区分开来。 单击保存以保存新定价计划。
    保存产品页面
  24. 现在，您可以单击产品的 “选项”图标 选项图标，然后单击 " 发布" ，将货币化产品发布到条纹测试目录中。
    发布产品页面
  25. 确保选择 stripe-test 目录，然后单击发布。
  26. 您可以通过单击侧导航栏中的 FindBranches 产品已发布，方法是单击侧导航栏中的 在API管理器UI导航窗格中管理图标 管理图标，然后选择条纹测试磁贴。 FindBranches 产品现已列在产品选项卡下。
    条纹测试目录的产品选项卡
    提示： 如果产品未显示，请记住单击 刷新 API 管理器用户界面导航窗格中的图标 Refresh 图标。

在 Stripe 账户中验证发布

您可以通过完成以下步骤来验证产品计划是否已发布到您的 Stripe 账户中。

  1. 登录到 Stripe 测试账户。
  2. 在开发者导航中选择 “活动 ”。
  3. 检查在发布产品计划时是否创建了事件。

在开发者门户中查看已货币化的产品

您可以通过完成以下步骤，在开发者门户中查看已货币化的产品。

  1. 在您的网络浏览器中打开开发者门户 ，查看条纹测试目录。 您无需登录。
  2. 您应在主页上看到 FindBranches 产品。
    开发者门户 显示 FindBranches 产品的首页
  3. 单击 FindBranches 磁贴，这样会显示“计划”，其中展示了缺省计划和 Gold 计划。 您可以看到 Gold 计划的定价信息，如果将鼠标悬停在文本 2 个速率限制上，那么可以查看速率限制详细信息。 应用程序编程接口消费者现在可以订阅这个货币化计划。
    FindBranches 产品开发者门户中的计划页面，显示黄金计划定价信息

您在本教程中执行的操作

在本教程中，您成功创建并发布了可供 API 使用者预订的货币化产品。 您完成了以下活动：

  • 创建了 Stripe 计费集成资源。
  • 配置了 stripe-test 目录。
  • 在开发者门户中启用条纹。
  • 创建并发布了货币化产品。
  • 在 Stripe 账户中验证了发布。
  • 在开发者门户中查看了已货币化的产品。