1.7. 对于 3scale 管理的 API 允许访问开发人员门户的要求

在授予 API 使用者访问开发人员门户之前,API 供应商必须执行以下任务:这些任务可同时执行:

  • 将 3scale 原生开发人员门户更改为具有您想要的外观和感觉:

    • Liquids:开发人员门户 演示了如何使用 Liquid 标记来显示和处理与 API 相关的 3scale 系统数据。liquid markup 是在 Developer Portal 页面添加逻辑的主要方法。
    • 自定义开发人员门户布局 描述了如何更改原生开发人员门户使其与您自己的品牌匹配。提供标准级联风格表(CSS),为您的自定义提供简单的起点。
    • 更改内置页面 解释了如何使用 CSS 和 JavaScript 在系统生成的页面中修改或隐藏一个元素。作为原生开发人员门户的一部分提供的所有页面都被称为系统生成的页面。

    熟悉 HTML、CSS、Liquid 和 web 站点的开发人员可修改原生 Echo API 开发者门户以创建您的开发人员门户。此开发人员可以在系统生成的页面中创建页面和修改代码,以创建您希望 API 用户在开发人员门户中看到的任何内容。

  • 定义 3scale API 产品、后端和应用程序计划,并为产品分配策略。

    3scale 产品是 3scale 资源,使您的 API 公开给消费者。在 Developer Portal 中,API 使用者读取产品文档并订阅使用产品提供的 API。3scale 产品有以下特征:

    • 捆绑一个或多个后端,它们是您创建的内部 3scale API。
    • 具有定义关于限制、定价和可用功能的产品使用规则的应用计划。
    • 具有 APIcast 网关配置,用于在向 API 发送 API 使用者调用前如何处理 API 使用者调用。您添加到产品的策略会改变默认的 APIcast 网关行为。

    请参阅管理门户指南

  • 导入定义并记录 3scale 管理的 API 的 OpenAPI 文档。

    开发人员门户的基础是一个 OpenAPI 文档,用于定义您的 API。当您将 OpenAPI 文档导入到 3scale 中时,3scale 会创建或更新 ActiveDoc,以便立即为您的 API 功能文档。在 Developer Portal 中,API 使用者使用本文档来探索、测试并与 API 集成。

    对于 OpenAPI 文档中定义的每个操作,导入文档会导致 3scale 创建方法和映射规则。方法和映射规则有助于强制强制对 API 使用者访问的限制和规则。

    开发者门户中提供 API 的 3scale 指南包含使用 3scale 和 OpenAPI 文档的信息和流程。特别是,请参阅 如何编写 OpenAPI 文档以用作 3scale 规格,并将 ActiveDocs 添加到 3scale

  • 配置 API 使用者如何注册以访问 3scale 管理的 API 的工作流。

    使用您的开发人员门户,注册工作流是 API 消费体验的关键方面。工作流可从自助式服务到对谁获得访问权限的全权控制。帐户、服务和应用计划提供多种级别的粒度。在每个级别,您可以控制是否有您操作的批准授权,以及是否需要 API 消费者作出任何选择。

    要获得最大自动化和自助服务,您可以删除所有批准步骤,并启用所有可能的默认计划。在注册后,您的开发人员门户可能会发布一个密钥,它提供您的开发人员门户的 API 使用者访问权限。

    原生开发人员门户为用户提供、帐户和应用程序注册的常用字段。您可能需要在这些常用的字段中添加自定义字段。详情请参阅配置注册流自定义注册表单字段。在自定义电子邮件模板前,请务必配置工作流。

  • 实施 API 使用者身份验证。

    对开发者门户的 API 使用者访问权限进行身份验证可保护开发人员门户资源和您的 API。您可以使用以下方法验证对开发人员门户的访问:

    请参阅开发人员门户身份验证

  • 自定义 3scale 原生模板,以获取开发人员门户和 API 用户之间的电子邮件通信。

    许多不同的事件需要开发人员门户和 API 用户之间的通信,包括在注册后提供帐户激活链接、密码恢复、服务费用、更改通知等。3scale 提供开发人员门户发送到 API 用户的每个典型电子邮件类型的模板。

    在定义了注册工作流后,自定义电子邮件内容。这可让您与为开发者门户设置的工作流匹配。

    请参阅 电子邮件模板Liquids:电子邮件模板

  • 指定 API 使用者必须同意访问 3scale 管理的 API 的条款、条件和策略。

    当您允许 API 用户注册和调用您的 API 时,您通常希望他们在授予访问权限前就您的条款、条件和策略达成一致。如果开发者门户提供多个服务,您可以有不同的术语和条件版本,例如:注册、使用特定应用程序或使用特定服务。

    如果您要使用 API,您可能需要同意您的信用卡策略。

    请参阅设置术语和条件

  • 设置 API 消费账单和信用卡网关。

    3scale 计费流程每天运行。它为订阅付费服务的每个 API 使用者帐户创建发票。发票可以处于以下状态之一: open, finalized, pending, unpaid, paid, failed, Canceled。3scale 使用您配置为处理发票的支付网关。

    3scale 计费流程可以在预付或后付模式下运行。3scale 中的计费基于日历月份,在月的第一天会发生特殊事件。

    请参阅 管理门户指南,Billing

在 Developer Portal 变为 live 之前,您必须执行最后的任务是删除访问代码。仅在对开发者门户进行身份验证进行身份验证后执行此操作,并在您彻底测试了开发人员门户后,以确认其行为已符合预期。

要删除访问代码,显示 Developer Portal > Content 环境。在右下角,单击 Open your Portal to the world 并确认此操作。