管理员门户指南

创建新帐户后，点顶部导航栏中的齿轮图标，然后单击 Account → Overview，然后点击 Details 项中的 Edit。填写您的帐户信息。

View larger image

您此处编写的地址是我们用于计费目的（如果您在付费计划中）以及用户在使用账单和支付模块时在发票上看到哪些地址。

在同一页面上，您还可以选择您将在所有系统上使用的时区。此设置会影响分析图形。但是，账单周期计算按照 UTC 时间进行。

3scale 支持您的成员和管理员的单点登录(SS0)身份验证。

3scale 管理门户支持以下 SSO 提供程序，各自支持多个身份代理和成员联合选项：

只有已添加到 RH SSO 或 Auth0 的用户才能通过 SSO 访问您的 3scale 管理门户。如果要进一步限制角色或用户组的访问，您应该在 RH SSO 或 Auth0 支持门户上步骤教程中引用对应的步骤。

通过所选提供程序建立 SSO 后，您必须进行配置并在 3scale 管理门户中启用它。

配置了 SSO 后，成员便可使用连接的 IdP 中的帐户凭据进行登录。

按照以下步骤，使用 SSO 登录 3scale 管理门户：

成功注册后，您将在 API 供应商组织下拥有一个 member 帐户，并且会自动登录。

这些步骤将显示 3scale API 管理管理员如何重定向到身份提供程序(IdP)登录屏幕(RH SSO)。完成这些步骤，可通过可选的单点登录(SSO)登录页面访问 3scale 帐户。

在管理门户顶部导航栏中，单击齿轮图标。然后，从左侧菜单中 导航到 Users > Listing。

View larger image

当我们引用用户时，我们将就您的团队成员讨论。3scale 管理门户有两种类型的用户：

在菜单中，单击 Invite user 链接。

View larger image

您可以在 Users > Invitations 中找到邀请。

View larger image

输入您要邀请的人员的电子邮件地址，然后点发送。将向您输入的地址发送邀请电子邮件。如果电子邮件未到达，请确保它没有标记为垃圾邮件。

您的新管理员或成员必须单击邀请电子邮件中的链接，并填写表格以完成该流程。提交表格后，其帐户将被激活。

您可以为团队成员授予两种主要的权利：

要授予新用户权限，请通过从用户菜单中选择新用户并单击 Edit 来编辑新用户。

更改他们对"admin"的权限将赋予他们控制管理门户的完整访问权限。

更改他们"成员"的权限将为您提供选择团队成员可访问哪些区域和服务的选项。

View larger image

授予对管理门户某些区域的访问权限后，成员只能访问等效的 API：

有不同类型的通知：

管理用户有权访问所有通知。

成员用户仅可以访问他们被授予访问权限的区域的通知。例如，如果某一成员有权访问计费部分，则他们只能访问与计费相关的通知。

对于 企业帐户，成员用户只能访问有关已授予访问权限的服务活动的通知。

订阅是个人的，仅可由接收这些通知的人员修改。编辑订阅：

View larger image

除了电子邮件通知外，您还可以在您的仪表板中找到它们：

View larger image

您可以在这里编辑 3 种类型的设置

View larger image

访问令牌允许 API 提供程序管理员和成员对 3scale API（账单、帐户管理和分析）进行身份验证，并使用我们的 ActiveDocs（交互式文档）进行尝试。

访问令牌可以提供读写访问权限，或者提供只读访问权限。

要考虑的一个重要事项是访问令牌的工作方式，而这取决于成员的权利。管理员可以创建令牌，以对所有 3scale API 进行身份验证。成员将受限于其访问管理门户不同部分的权限。例如，如果某一成员无法访问 Billing 区域，他们将无法创建令牌来针对 Billing API 进行身份验证。

可以在令牌页面中创建访问令牌。要访问令牌页面，请点击页面右上角的齿轮图标，然后导航到 Personal > Tokens。

View larger image

单击 Add Access Token，再选择 name, scope, and permissions。

View larger image

请注意，如果您是一个成员，您可能不会看到所有 API - 只是帐户管理员有权访问的所有 API。

您可以根据需要创建任意数量的访问令牌，但出于安全原因考虑，它们不会存储在 3scale 中。在创建新令牌时，您将获得保存令牌的警报，以便您可以使用它向 3scale API 发出请求。如果您丢失了令牌，我们建议将其删除 - 将禁用该令牌并呈现无效 - 然后创建一个新令牌。

在使用访问令牌对 3scale API 发出调用时，结果将按您可访问的服务过滤。

例如，在部署 APIcast 自我管理时，您需要访问令牌，以便 APIcast API 网关可以使用帐户管理 API 拉取服务配置。

它的工作方式是，如果您的组织在 3scale 上设置了三个服务，并且作为成员，您有权访问服务 1，但不能 2 和 3，并且您也可访问帐户管理 API，当您创建令牌并对帐户管理 API 发出请求时，您只能获取正在使用服务 1 的应用程序。

遵循同一示例，如果您可以访问帐户管理 API，但在进行调用时可以访问零个服务，您将收到"access denied"错误。

6.3.1. 服务令牌

复制链接

服务令牌用于对 3scale 服务管理 API 进行身份验证。当在 3scale 中创建新服务时，服务令牌会自动生成，并且每个服务都是唯一的。它们由 3scale 帐户的用户共享。您可以在管理门户的 Dashboard: Account Settings(gear icon)> Personal > Tokens 中查找用户可访问的服务的服务帐户令牌。

View larger image

主管理员通过主管理门户和 API 端点监控和管理 3scale 帐户。与标准 管理门户 类似，主管理门户包含关于部署中的所有帐户的信息，并允许通过唯一的帐户页面管理帐户和用户。

如需帐户管理员操作的详细信息，请参阅 帐户 指南。

7.1.1. 访问主管理门户

复制链接

要访问主管理门户，您需要在内部安装过程中使用专门为主管理门户定义的凭据和 URL。

主管理门户 URL 由 MASTER_NAME （模板中默认为master ）和 WILDCARD_DOMAIN 组成：

<MASTER_NAME>.<WILDCARD_DOMAIN>

Copy to Clipboard Toggle word wrap

您可以通过 Master 标志来识别主管理门户。

View larger image

您可以通过主管理门户或通过 API 调用来管理帐户。

7.2.2. 通过 API 调用管理帐户

复制链接

您可以通过 Master Admin API 调用来管理帐户。有关这些调用的详情，请参考 Master API 部分，具体操作为：单击主管理门户右上角的问号(?)图标，然后选择 3scale API 文档。

View larger image

由于同一 OpenShift 集群域中存在多个帐户，各个帐户名称会将 OpenShift 集群域名作为子域预先填充。例如，集群中名为 user 且域为 example.com 的帐户的路由如下：

user.example.com

user.example.com

标准多租户部署包括：

master admin 添加的其他帐户将根据其名称分配一个子域。

恢复租户帐户意味着恢复计划删除的帐户。您可以在调度删除后最多恢复租户帐户 15 天。

恢复帐户后：

通过使用服务发现，您可以扫描以查找在同一 OpenShift 集群中运行的可发现 API 服务，并将关联的 API 定义自动导入到 3scale 中。

您还可以随时更新 API 集成和 Open API 规格，然后与集群重新同步它们。

服务发现提供以下功能：

当您导入可发现的服务时，它会保留其命名空间。

作为 3scale 管理员，您可以使用或不使用 OAuth 服务器来配置服务发现。

您可以发现一个与 OpenAPI 规范(OAS 也称为 Swagger 规格)对应的新 API 服务（如果适用）；可在集群中发现该 API 服务以使用 3scale 管理。

作为 OpenShift 项目管理员，您可以在 OAuth 令牌无效时授权 3scale 用户访问命名空间。

您可以使用集群中该服务的当前定义在 3scale 中更新（刷新）现有 API 服务。

您稍后可以更改该方法的定义。只需单击方法名称（在列中的 Method 中），更新字段并单击"更新方法"。

在更改方法和指标的系统名称或删除它们时，请非常小心！如果存在映射到方法先前系统名称的映射规则，则可能会破坏您已部署的 3scale 集成。

要创建新指标，请单击 New metric 并提供所需的参数。在指定单元时，请使用 singular noun （如 "hit"），因为它将在分析图表中自动复数。

这些新的方法和指标将在您的当前和未来的计划中可用。现在，您可以在每个计划上编辑限制和定价规则，进入 [Your_API_service] > Applications > Application Plans > [plan_you_want_to_edit]。

如果您的 API 具有很多端点，我们提供了在 3scale 上自动创建方法和指标的另外一种方法：

默认情况下，当您创建 3scale 帐户时，会给出两个计划： Basic 和 Unlimited。您可以保留并编辑这些设置，也可以自行创建。您可以根据需要创建更多计划。

要创建新应用程序计划，请按照以下步骤执行：

View larger image

在下一屏幕中，为您的新计划选择一个名称和系统名称（系统名称必须是唯一的）。如果应用程序需要批准？ 复选框，则不会在没有批准的情况下访问您的 API。

View larger image

创建计划后，您可以调配 速率限值 并设置 支付计划。

创建完所有计划后，您可以在注册应用程序的人员选择默认计划。要做到这一点，请导航到 [Your_API_service] > Applications > Application Plans，然后选择默认计划：

View larger image

如果您没有指明默认的应用计划，当新用户注册以访问您的 API 时，默认不会创建应用程序（提示他们不会真正获得对 API 的访问）。

第一个决策是区分定价模式中的分层。层是否由卷/使用、API 功能、对其他资源的访问或组合驱动？

在决定价格驱动程序后，您必须确定是否基于平板费率订阅、可变费率或一次性前期收费。上述所有三个定价驱动程序均与一个脱机或每月平价订阅兼容。如果您根据点击量或资源消耗决定您的定价，那么您的定价当然会有一个可变因素。

您可以创建新应用计划或编辑现有应用程序计划。在创建新应用程序计划时，您可以输入任何前期费用或无格式费率订阅。

View larger image

在编辑应用程序视图中，您可以输入或修改前期收费和订阅。

接下来，设置在第 1 步中决定的定价驱动程序。如果其中一些已作为指标存在，只需编辑项目。

View larger image

View larger image

完成设置定价规则后，请务必点击"更新应用程序计划"。

使用单个应用程序计划定义 API 付费计划是好的。通常，如果所有定价规则都由卷或资源驱动程序定义，则情况通常是如此。但是，如果您要为开发人员社区的不同部分提供单独的计划，则需要添加更多应用程序计划。

执行此操作的最简单方法是从应用计划概览页面复制第一个应用计划。这样，它将预先填充所有现有的指标和定价规则。第一次创建完整计划时，计划复制功能的保存时间就越高。

为了调配计划，开发人员必须创建新应用程序并选择新付费计划之一。您还可以从管理控制台代表他们执行此操作。对于任何现有应用程序，也可以从现有计划更改为新付费计划之一。

与扁平定价计划相结合，通常使用速率限值来区分不同的分层。这在 规定速率限值中解释

如果您尚未定义应用计划，请首先创建一个。否则，请选择您要为 设定速率限值的计划，然后单击 edit。

View larger image

当您完成设置所需的限值后，点 Update Application plan 保存您的更改。

现在您已经定义了速率限值，现在会出现以下情况：

当您的速率限制正常运行后，您会看到达到仪表板限制的用户，以便快速轻松地检查潜在计划升级候选者。

View larger image

除了设置速率限制外，您还可以为同一指标设置变量定价规则 - 请参阅 置备已付计划

3scale 中的计费基于日历月份，可以是 Prepaid 和 *Postpaid。

如需更多详细信息，请参阅自动计费流程。

此设置可启用信用卡交易。出现此设置时，将通过选定的支付网关收取所有到期发票的费用。如果您关闭此设定，将开具账单并发出发票，但不会进行实际付款交易。

选择进行计费和信用卡交易的货币。请确定您的支付网关支持选定的货币。此设置是全局的，适用于所有发票和交易；无法为不同的开发人员帐户设置不同的规定。

每张 PDF 发票的底部会显示在 Invoice footnote 字段中介绍的文本。您可以使用此字段为您的客户提供有关计费和计费策略的附加信息。

如果更改了 footnote 的文本，则它不会自动应用到已生成 PDF 的发票。但是，可以通过重新生成 PDF 发票来应用更改。

此字段用于向 PDF 发票中添加文本消息，以防 VAT/ Sales Tax 为 0% 的帐单帐户。仅当 VAT/ Sales Tax 明确设置为 0 时，才会显示此行，否则不会显示该行。此文本也将显示在管理门户的 Invoice 页面上。

有关此设置的更多信息，请参阅 VAT/ Sales Tax 部分

3scale 中的发票具有两种类型的 ID：

此设置定义了发票 Friendly ID 的格式：

将发票 ID 的计费周期从"月"更改为"年"的唯一影响是更改友好的 ID 格式，这不会更改计费周期，3scale API 管理只支持每月账单。如果您的会计部门有此类要求，则可以按年将发票 ID 的格式更改为年。

如果您每年需要向客户收取计费费用，则需要手动处理计费 - 您可以创建新发票并添加具有年度成本的行项。如果您更喜欢使用年费，您可能还希望将应用程序计划设置为免费，以确保每月自动生成发票和/或自动收取发票。

您可以在此处配置指向以下页面的路径：

3scale 与信用卡交易的以下支付网关集成：

14.8.1. 条带集成（推荐）

复制链接

完成这些步骤后，您要将 Stripe 配置为您帐户的支付网关。这将使开发人员输入他们的信用卡详细信息，并根据计算的发票，自动通过 Stripe 访问您的 API。

如果您为付费 API 启用信用卡付款，则一个关键步骤是设置您的 支付网关。您可以将多个替代支付网关用于 3scale 帐户。在这里，我们将介绍 Stripe 的步骤。

14.8.1.1. 先决条件

复制链接

在开始这些步骤前，您将需要打开一个 Stripe 的帐户。

14.8.1.2. 从 Stripe 获取您的 API 密钥

复制链接

登录到您的 Stripe 帐户，并在 https://dashboard.stripe.com/account/apikeys 获取您的 API 密钥。您需要两个键：一个"secret"，以及一个"可发布"一个。当您准备好启动慈善时，请使用"test"设置。

View larger image

14.8.1.3. 在 3scale 中配置设置

复制链接

您需要告诉 3scale 使用这些 API 密钥。要做到这一点，登录到 3scale 管理门户，然后进入 Audience > Billing > Charging & Gateway。

View larger image

如果 Charging Enabled 标志未激活，请启用它并单击 Save。

View larger image

您应该会在页面底部附近看到一个名为 Gateway 的下拉列表。将其更改为条带.

View larger image

下拉菜单下的表单应更改为显示两个字段。插入您的 Stripe API 密钥并点 Save。

View larger image

更改支付网关时，您可能会看到一些警告。这是预期的。读它们并接受它们（如果出现）。

支付网关现已设置，但您的用户可能还没有使用它，因为它没有配置 CMS。前往开发者门户，然后单击名为 pay Gateway / Show on the left navigation 窗格的模板。

View larger image

如果还没有存在，在 {% "braintree_blue" %} 前添加以下代码：

{% when "stripe" %}
 <p><a href="{{ current_account.edit_stripe_billing_address_url }}">Edit billing address</a></p>

 {% if current_account.has_billing_address? %}
   {% stripe_form "Edit Credit Card Details" %}
 {% else %}
   <p>After entering billing address, the option to enter credit card will be enabled.</p>
 {% endif %}

Copy to Clipboard Toggle word wrap

最后，单击 Save and Publish。您的用户现在应该可以使用 Stripe 网关来支付。

注意

要将 Stripe 数据与 3scale 上的数据映射，您可以使用名为 metadata.3scale_account_reference 的 Stripe 字段，该引用由 3scale-[ural_ID]-[DEVELOPER_ACCOUNT_ID]组成

14.8.2. Braintree 集成

复制链接

以下是设置 Braintree 网关以收费使用 API 的步骤。

14.8.2.1. 从 Braintree 获取您的 API 密钥

复制链接

您需要使用 Braintree 打开一个客户。您需要一个网关和 Merchant 帐户加上 Vault。作为可选的额外选择，您可以选择允许 American Express 卡作为支付方式。

首先，登录到您的 Braintree 帐户。然后，在 Account > MyUser 区域中找到您的 API 密钥：

View larger image

API 密钥页面仍然隐藏私钥，因此请选择查看它的选项：

View larger image

最后，您有 3scale 账单设置所需的公钥、私钥和 Merchant ID：

View larger image

14.8.2.2. 在 3scale 中配置设置

复制链接

您需要告诉 3scale 使用这些 API 密钥。要做到这一点，登录到 3scale 管理门户，再进入 Audience > Billing > Charging & Gateway。

确保账单页面中指定的货币类型与 Braintree merchant 帐户中使用的货币类型相符。

View larger image

如果 Charging Enabled 标志未激活，请启用它并单击 Save。

View larger image

您应该会在页面底部附近看到一个名为 Gateway 的下拉列表。将它更改为 Braintree(Blue Platform)。

View larger image

下拉菜单下的表单应更改为显示两个字段。插入 Braintree 键并点 Save。

View larger image

更改支付网关时，您可能会看到一些警告。这是预期的。读取并接受（如果它们显示）。

您的用户现在应该能够使用 Braintree 网关支付费用。

注意

要将 Braintree 中的数据映射到 3scale 上的数据，您可以使用名为 customer.id 的 Braintree 字段，它由 3scale-[PROVIDER_ID]-[DEVELOPER_ACCOUNT_ID]组成。

14.8.2.2.1. 故障排除

复制链接

如果您的帐户处于沙盒模式，并且您遇到任何问题，您必须将其更改为生产。

14.8.3. 弃用的支付网关

复制链接

本节提供有关已弃用支付网关的一般信息：Adyen。此处的信息仅用于现有集成。不支持与这些网关的新集成。

14.8.3.1. Adyen 集成

复制链接

重要

Adyen 集成已被弃用。不支持新的集成。对于 2019 年 8 月 22 日之前存在的集成，红帽提供支持，但建议迁移到完全支持的支付网关之一： Stripe 和 Braintree。

完成这些步骤后，您要将 Adyen 配置为您帐户的支付网关。这将使开发人员输入他们的信用卡详细信息，并根据计算的发票，自动通过 Adyen 访问您的 API。

设置您的支付网关是使信用卡收费使用付费 API 的关键步骤。您可以将多个替代支付网关用于 3scale 帐户。在这里，我们介绍了 Adyen 的步骤。

14.8.3.1.1. 先决条件

复制链接

• 在开始这些步骤前，您需要使用 Adyen 打开一个帐户。
• 您需要一个 公司帐户 和一个 Merchant 帐户（子帐户）。
• 在通过 Adyen 应用实时帐户之前，必须满足许多要求。您可以在此处查看这些要求。https://docs.adyen.com/support/getting-started#howtogetanadyenliveaccount
• 帐户应处于 production 模式。

14.8.3.1.2. 配置 Adyen 集成

复制链接

在您的 Adyen 帐户中找到信息

1. 首先，登录到您的 Adyen 帐户。然后，在 Settings > Users 区域中找到您的凭证，并在以下视图中从下拉菜单中选择 System ：

View larger image

2. 单击 Company 帐户（列表顶部的帐户）。然后您将进入 Company 帐户设置视图：

View larger image

3. 最后，您可以访问 登录、Secret 密码、客户端加密公钥、Merchant ID 和库位置，您需要进行 3scale 账单设置。
4. 要查看 公钥，您必须单击 Generate Password 并在某个位置复制此密码。

View larger image

在 3scale 帐户中配置您的支付网关

1. 在 Audience > Billing > Charging & Gateway 中，选中复选框并点 Save 来启用计费。
2. 您将看到您需要设置的所有字段来创建到 Adyen 网关的链接。
3. 您必须从 网关 下拉菜单中选择 Adyen 并保存更改。

View larger image

在 Adyen API 响应中启用 别名 附加数据

默认情况下，当信用卡授权请求从 3scale 发送到 Adyen 时，返回的响应不包括信用卡的唯一标识符。

为确保将正确的信用卡引用保存在 3scale 中，并收取正确的卡，需要启用额外的数据。

联系 Adyen 支持，以在响应授权请求中启用 别名 附加数据。

测试您的计费工作流

1. 通过启用 Prepaid Mode 在一天中生成收费，确保您加快测试周期。

2. 然后，选择现有的测试帐户，并创建添加行项目收费的发票。

   1. 立即收取帐户费用。
   2. 这种测试方法将产生一些细微成本，但值得注意的是，在获得使用 API 真实付费开发人员之前，一切都可以正常工作。

支付网关现已设置，但您的用户可能还没有使用它，因为它没有在 CMS 中配置。前往开发人员门户选项卡，找到名为 Payment Gateway / Show on the left navigation 窗格的模板。

如果还没有存在，请在代码块的 "stripe" %}开头后添加以下代码片段。

{% when "adyen12" %}
{% if current_account.has_billing_address? %}
  {% adyen12_form %}
{% else %}
  <p><a href="{{ current_account.edit_adyen12_billing_address_url }}">First add a billing address</a></p>
{% endif %}

Copy to Clipboard Toggle word wrap

注意

• 要将 Adyen 数据映射到 3scale 上的数据，您可以使用名为 shopperReference 的 Adyen 字段，它由 3scale-[PROVIDER_ID]-[DEVELOPER_ACCOUNT_ID]组成

定价规则定义每个 API 请求的成本。同一指标的多个定价规则在适用定价规则时划分了范围。定价规则基于日历月份，计数器在每月第 1 天的 00:00 UTC 重置。

Until 100 calls per month (from 1 to 100) each API call can be charged at $0.04, and starting from the call 101 (from 101 to infinity) the calls are charged at $0.10.

Until 100 calls per month (from 1 to 100) each API call can be charged at $0.04, and starting from the call 101 (from 101 to infinity) the calls are charged at $0.10.

The first 1000 calls are not charged (cost $0), because they are included in the plan which has a monthly fixed cost. Starting from call 1001, each call is charged at $0.50.

The first 1000 calls are not charged (cost $0), because they are included in the plan which has a monthly fixed cost. Starting from call 1001, each call is charged at $0.50.

Calls from 1 to 100 are charged at $0.30, 100 to 500 – at $0.40, and 500 and further – at $0.50.

Calls from 1 to 100 are charged at $0.30, 100 to 500 – at $0.40, and 500 and further – at $0.50.

重复最后两个步骤，以创建所有必要的定价规则范围。

将 To 字段留空，将规则设置为 " to infinity"。

指标成本的最大十进制数设置为 4，如果添加的数字包含更多十进制数，则该值将舍入到带有 4 十进制位置的数字。

在 Audience > Billing > Earning by month 部分，您可以找到您的到期和收到的付款概述，根据情况计算，计算为当月发出的所有发票的总和：

单击具体月，您可以列出该月的所有发票。

您还可以通过转至 Audience > Billing > Invoices 来查看发票列表，您可以在其中按 ID（友好 ID）、帐户名称以及按月份和状态过滤发票。

特定开发人员帐户的发票也可在 Audience > Accounts > Listing > [selected account]（其中 X 是帐户拥有的发票数）的面包屑导航页面的 X Invoices 下找到。

如果单击发票列表中的发票友好 ID，您将看到发票的详细信息。

发票可处于以下状态之一：

在 3scale 中，账单流程每天运行。它生成发票，并根据计费流程更改其状态，并使用配置的支付网关来执行费用。

Prepaid 和 Postpaid 模式的计费流程略有不同，因为 3scale 中的账单基于日历月，当月的第一天发生特殊事件。

自动化账单流程为订阅付费服务的所有开发人员帐户生成发票。

计费可以在全局范围内启用或禁用（请参阅 Billing 和 Charging 设置 ），但也可以启用或禁用每个开发人员帐户的计费和计费。要做到这一点，进入帐户页面并点击对应的按钮（启用/禁用）：

如果收费被停用，并且启用了计费，开发人员将被签发发票，但不会收取费用。这在您单独处理计费时很有用（例如，电汇）。

如果两者均被禁用，则不会发布或收取开发人员费用。

如果账单被禁用，并且启用了收费，则不会向开发人员支付任何新的发票，但所有未付发票（Pending 和 Failed）仍会收费。

在此 Billing Status 块中，您还可以查看是否在帐户上配置了信用卡详细信息。如果配置了信用卡详细信息，则显示卡到期月份和年份。信用卡详情的存在可能会影响开发人员门户注册和计划更改的流（请参阅 第 16.9 节 “信用卡流”）。

可以为付费计划设定试用期（按天数计），以延迟收取指定天数的费用。

在应用程序列表([Your_API_service] > Applications > Listing )中的应用程序将显示试用周期状态，在 State 列中显示为 "live - trial expires in N days"，并在 Trial days left 字段中的应用程序详情页面中显示。

在试验期间，应用可以无限制地使用计划定义的所有功能和使用限制。

一旦设定了试用期，便无法取消或延长试用期。升级至其他计划将不会重置试用日计数器。

试用期到期 10 天前，将向开发人员帐户发送电子邮件通知，通知即将开始的试用期。这个电子邮件的模板可以在 Audience > Messages > Email Templates 中配置：对于应用程序计划，选择 "Application trial period expired for buyer"，对于具有试用期的服务计划，选择 "Service trial period expired for buyer"。开发人员应保留在当前计划中，或者切换到另一个计划；或者，如果他们决定取消订阅，请联系 API 提供程序。

试用期结束后，开发人员将按照当前应用程序或服务的计划所设定的成本收取自动账单运行时间（请参阅 第 16.4 节 “自动计费流程”）。请注意，在试用期到期后，申请 不会被 阻止或暂停，并且将继续工作。

请注意，虽然技术上可以为免费计划设置试用期，但建议不要这样做，因为该功能会丢失其有用性。

增值税务(VAT)是一种税款，适用于在欧盟内部销售的产品和服务。在其他国家/地区也有类似的税款，例如销售税。收取客户使用 API 服务的 API 供应商通常还需要收取税款，并将其反映在发票中以符合现有法规。

3scale 账单配置后，可以在发票中自动包含 VAT。

_Total cost (without <VAT rate>)_ +
_<VAT rate> Amount_ +
_Total cost (<VAT rate> <VAT rate value>% included)_

_Total cost (without <VAT rate>)_ +
_<VAT rate> Amount_ +
_Total cost (<VAT rate> <VAT rate value>% included)_

开发人员可以管理他们的信用卡信息，并在开发人员门户中查看他们的发票。

Audience > Developer Portal > Feature Visibility 中的 Finance 切换必须处于 可见 状态，以便开发人员查看开发人员门户中的与计费相关的元素。

登录的用户可以通过 Settings > Credit Card Details 更新信用卡详情。根据付款网关配置的支付网关，表单可能有所不同，用户可能需要先输入计费地址。

*note:* Credit 卡详情没有存储在 3scale API 管理数据库中，它由支付网关管理。只有信用卡号码的最后 4 位数字，到期日期以及支付网关提供的参考信息存储在 3scale API 管理数据库中。

开发人员只能在开发人员门户上有一个信用卡。

无法从开发人员门户中删除信用卡详情。希望删除其信用卡详细信息的开发人员帐户用户需要请求 API 供应商从系统中删除信用卡详细信息。

要查看发票，用户可以转到 Settings > Invoices，可以从那里显示每个发票的详情，或下载发票 PDF。

当开发人员在开发人员门户中输入信用卡详细信息上的账单地址时，此地址将独立于"传统"帐户地址存储。

默认情况下，该法律地址会出现在 Issued to 字段中的 Invoices 中。但是，如果开发人员没有配置法律地址，而只配置计费地址，后者将用于发票(请注意： 在这种情况下，组织名称被视为地址的一部分)。

默认情况下，账单地址在管理门户或通过 API 中不可见，但您可以添加如下：

现在，<billing_address> 字段会出现在帐户管理 API 和 Webhook 的 XML 模型中。对应的账单地址将在帐户和管理门户的帐户编辑页面中以只读方式显示。

开发人员可以在开发人员门户中更改账单地址（在 Credit Card Details 部分中）。管理员不能更改管理门户中的计费地址，但可以使用以下字段（作为"附加字段"）通过帐户管理 API 的帐户 编辑 端点来执行此操作：

billing_address_name
billing_address_address1
billing_address_address2
billing_address_country
billing_address_city
billing_address_state
billing_address_zip
billing_address_phone

billing_address_name
billing_address_address1
billing_address_address2
billing_address_country
billing_address_city
billing_address_state
billing_address_zip
billing_address_phone

3scale 帐户的用户（具有 Billing 权限的管理员和成员）可以订阅或取消订阅与 帐户设置相关的通知（右上角的gear图标） > Personal > Notification Preferences （Billing 部分）：

注意：3scale 帐户的所有管理员用户如果订阅了账单，将收到关于账单的通知。

发送到开发人员帐户的电子邮件通知可在 Audience > Messages > Email Templates 上配置。可用的电子邮件如下：

开发人员帐户的所有管理员用户将收到上述通知。

作为管理员，您甚至可以跳过一些必填字段。如果要安全地邀请用户访问 帐户，您也可以跳过密码字段。但是，此主要 admin 帐户上的电子邮件必须在所有用户之间唯一。

View larger image

如果要为帐户预配置应用密钥，您也可以代表开发人员添加应用。否则，请将此保留为开发人员要执行的初始步骤之一。

View larger image

您可以手动向开发人员发送电子邮件邀请，或者按照步骤使用 邀请开发人员 功能。

如果您（作为管理员）收到其中一个开发人员有待批准项目的电子邮件通知，您可以将项目的 URL 复制到浏览器中，然后它会把您直接转至页面进行批准。

要搜索特定帐户或过滤处于"pending"（用于批准）状态的所有帐户，请导航到 Audience > Accounts > Listing。要仅显示待处理的帐户，请在 State 下拉列表中选择 "Pending"， 然后单击 搜索。

您可以在每行上直接进行单独批准，或者一次选择几行并执行批量批准。

View larger image

要搜索服务的特定订阅或过滤处于 "pending"（用于批准）状态的所有订阅，请导航到 Audience > Accounts > Subscriptions。

要查看订阅，请在 Audience > Accounts > usage Rules 中启用服务计划。

您可以一次选择一个订阅或多个订阅并执行批量批准。

View larger image

搜索应用程序或过滤处于"待处理"（用于批准）状态的所有应用程序：

您可以一次选择一个应用程序或多个应用程序并执行批量批准。

View larger image

您也可以从开发人员帐户的详情页面开始，选择您要从那里批准的应用程序，然后对应用程序详情页面进行批准。

View larger image

View larger image

要搜索或过滤特定的帐户，请导航到 Audience > Accounts > Listing。

您可以一次选择一行或多行，然后更改计划。

View larger image

要搜索或过滤服务的特定订阅，请导航到 Audience > Accounts > Subscriptions。

只有在 Settings 页面中启用了 Service Plans 时，才可查看订阅。

您可以一次选择一个或多个订阅，并更改计划。

View larger image

要搜索或过滤特定应用程序，请导航到 Audience > Applications > Listing。

您可以一次选择一个或多个应用程序，并更改计划。

View larger image

另一种场景是从开发人员帐户的详情页面开始。从那里您选择要更改计划的应用程序。在应用程序详情页面上，您可以更改计划。

View larger image

如果您已经知道管理相关应用的帐户和开发人员，请在 Audience > Accounts > Listing 的 Accounts 页面中导航至其帐户，如下所示。

View larger image

如果您只具有应用程序 ID 或 API 密钥，您可以使用 Audience > Accounts > Listing 中的 Accounts 页面中的搜索框来查找相关帐户。有关查找应用程序的更多信息，请访问 此处。

在帐户配置文件页面中如下方所示，单击消息图标。

View larger image

此处创建的消息将同时发送到帐户系统仪表板，帐户中的所有开发人员都将看到该仪表板，并通过通过电子邮件发送给开发人员帐户中具有管理员状态的人员。

如果紧急情况和电子邮件不太可能足够快用于您的目的，您还可以使用注册时开发人员提交的联系信息，该信息可以：

请注意，注册后，您可以将联系人电话号码填写为必填字段。

查看您感兴趣的开发人员帐户详情页面：

View larger image

选择您要自定义的计划应用程序。

View larger image

选择"自定义"选项。这提供了 页面，您可以在其中为此帐户拥有的应用自定义所有计划元素。

View larger image

要查找应用程序，您需要其所属帐户的名称或应用程序的名称。如果您没有此信息，您可以验证访问日志。要执行搜索，请导航到 Applications(Audience > Applications > Listing)。

如果按标识符搜索验证类型，您需要以下信息：

要搜索给定应用程序，请导航到 Applications 页面(Audience > Applications > Listing)，并使用以下镜像所示的搜索框。

View larger image

返回结果后，单击您要访问的应用程序，然后您将进入该应用程序的主页，其中包括如下图中所示的信息。

View larger image

从他们通过管理门户订阅的服务中取消订阅单个开发人员：

执行批量操作，从已弃用或删除的服务中取消订阅多个开发人员：

请记住，需要启用服务计划。

您可以从 帐户 或应用程序选项卡找到 应用程序，或者按 此处 所示搜索。

找到应用程序并查看应用程序摘要页面后，点击"状态"值旁边的挂起图标。此操作将立即从 API 禁用应用，并暂停所有密钥正常工作。控制系统将拒绝使用这些应用密钥的调用。

修改有问题的行为后，可以使用同一按钮取消暂停应用。

View larger image

如何联系应用的开发人员将依赖于您的工作流和策略。在同一页面中，您可以单击帐户名称，该名称将使您进入帐户视图，从中可以识别拥有该应用的帐户的关键管理员。您可以通过电子邮件或单击显示的发送消息按钮联系他们，这将为用户生成仪表板消息。

View larger image

在使用本指南前，完成 Getting Started 部分的说明。

本指南假定您使用其中一个现有的 3scale 代码插件来执行集成。您可以遵循与其他集成方法类似的流程。检查文档中的 Operating APIcast 章节，以了解更多有关可用的集成选项的信息。

3scale 充当 API 统计的无限可扩展数据存储库，您可以跟踪 API 的几乎任何指标。例如：

您可以跟踪与 API 相关的更多指标。3scale 可以跟踪任意数量的指标和方法，只要它是可随着时间递增的可数。

选择指标后，在 3scale 管理门户中注册它们。导航到 [your_API_name] > Integration > Methods & Metrics。

图 30.1. 创建新方法

View larger image

在服务中添加指标和方法。为其提供友好的名称和系统名称，稍后在插件配置中使用。有关创建方法和指标的详情，请参阅在 3scale 中定义您的 API。

使用要跟踪的指标名称配置了 3scale 系统后，就可以调整插件设置来报告正确的指标。执行此操作的具体方式取决于所使用的插件或集成方法。默认情况下，插件只报告 hits (API 事务)指标。

通常说，您需要按照以下步骤操作。

当您报告特定 API 方法的流量时，在 metric 参数中使用方法 系统名称。这会自动为报告的方法和 hits 指标增加计数器。

建立 API 和 3scale 连接后，您可以将流量发送到 API，并在 API 分析仪表板中监视它。您需要现有的开发人员帐户和一个具有 API 凭据的应用程序才能执行本节中的步骤。按照以下步骤创建开发人员帐户并获取具有 API 凭据的应用。

如果分析部分的 usage chart 上没有显示流量，请执行以下检查。

默认情况下，使用量统计通过管理门户和通过开发人员门户创建应用程序的开发人员查看 API 提供程序。（每个开发人员只能看到他们自己的应用程序的用量统计。） 您可以从 Developer Portal 中隐藏分析视图。请参阅 创建开发人员门户 部分，以了解更多有关自定义开发人员门户的信息。

除了分析部分中的使用图外，还有其他方法获取 API 分析数据。

3scale 不断改进 API 控制面板中提供的功能。但是，您可能处于我们的开发计划前，并且具有尚不受支持的非常具体的需求。

为了满足对 API 管理的需求，3scale 始终为您提供了访问所有数据的工具。但是，自定义脚本有一些成本 - 它需要一些资源来编写脚本，但成本不是高的，我们会在本文中显示。更重要的是，DIDI 为您提供总体灵活性和控制力，以实施您认为的任何用例。

最近，一个客户会给我们提供非常具体的需要，这些需要无法以精简的方式通过 3scale 解决。

他们每周已上千名新开发人员。借助 3scale API 管理平台，他们可以继续获得这样的成功。如此多的开发人员将是一项艰巨的任务 - luckily 3scale 提供自动化操作，如关键配置、注册工作流和电子邮件通信。到目前为止，我们非常好。

然而，有些问题无法与 3scale 相关，这对于他们而言非常重要。由于他们入职如此多的人，他们需要一个直接的方式根据其 API 参与对新开发人员进行分类，以便他们的运营和营销团队可以更有效地与新开发人员进行交互。

3scale 的内置工具中尚不提供此功能（至少必需的详细信息）。但是，由于所有数据都可用，因此可以使用 3scale 的帐户和分析 API 提取数据。

他们希望了解过去 10 天内有多少新开发人员注册了免费评估计划，划分了不同的方式。

首先，他们想要知道注册多少开发人员，但没有使用其 API。他们希望了解这些信息超出了本文档的范围，但非常宝贵的信息有助于采用您的 API。

其次，他们希望将已使用 API 的开发人员分成两个组：

此信息可用于 3scale 的内置分析。问题是没有可以合并的视图，这导致整个体验非常繁琐。

此问题的典型答案将是 后续的分析改进的一部分。（有趣的是通常就是这种情况。） 但如果您需要，这不会解决这个问题。我们在 3scale 上想要提供您完成所有工作的工具，而无需根据我们的发行时间表。

3scale 是一个容易自我管理的系统。我们相信，任何人都应当能够扩展他们接受合同的任何服务的当前功能。正如我们想到的那样，我们可以覆盖所有基础，我们将始终是某方面的内容，无论它是超级特殊需求，还是只是因为我们正在构建其他功能。无论哪种情况，我们都想避免避免在无法立即阻止。我们为您提供数据的完全访问权限，以及能够与其配合使用的完整 API 工具集。

如果您有要与我们和 3scale 的用户共享的脚本，请将其发送给我们。我们很高兴收集并发布它们。

您可以在 Audience > Accounts > Listing 或 Audience > Applications > Listing 中查找应用程序，或者搜索，如查找的应用程序指南 中所述。

找到应用程序后，您将看到一个概述屏幕，其中包含有关应用程序的信息，如下图所示。

View larger image

图中标记的项目与以下信息对应：

要获取应用程序的分析页面，请访问应用程序，并点击应用程序名称上方的链接中的 分析。这将把您带到应用程序的使用图表视图，如下图所示。

View larger image

通过控制指标、方法和时间范围，您可以检查应用的不同类型的数据。