管理员门户指南

创建新帐户后，按照以下步骤添加您的公司信息：

您此处指定的解决方案有两个目标：

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

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

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

只有添加到 Red Hat Single sign-on 或 Auth0 的用户才能通过 SSO 访问您的 3scale 管理门户。如果要进一步限制角色或用户组的访问权限，您应该通过红帽单点登录或 Auth0 支持门户上的步骤教程 来引用 相应的步骤。

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

配置了 SSO 后，成员就可以使用连接的身份提供程序(IdP)中的帐户凭据进行登录。

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

成功注册后，您将在应用程序编程接口(API)供应商组织下拥有一个成员帐户，并且会自动登录。

本节论述了通过红帽单点登录重定向到 IdP 登录窗口。作为 3scale API 管理管理员，请完成以下步骤，使 3scale 帐户可通过可选的 SSO 登录页面访问。

要查看 3scale 安装的用户列表，请在管理门户页面中按照以下步骤执行：

从用户列表中，您可以邀请新的团队成员。发送邀请：

将向您输入的地址发送邀请电子邮件。如果电子邮件未到达，请确保在收件人的电子邮件帐户中未将其标记为垃圾邮件。

另外，您可以在 Users > Invitations 中找到发送的邀请列表和状态。

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

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

要授予新用户权限，请通过从用户菜单中选择新用户并单击 Edit 来编辑新用户。您有以下用户角色：

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

有不同类型的通知：

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

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

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

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

除了电子邮件通知外，您还可以在仪表板中找到关于最近一次活动的信息：

访问令牌允许应用程序编程接口(API)供应商管理员和成员对 3scale API （账单、帐户管理和分析）进行身份验证，并使用我们的 ActiveDocs 尝试它们。

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

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

可以在令牌页面中创建访问令牌。要创建令牌，请按照以下步骤执行：

请注意，如果您是成员，您可能看不到所有 API - 只是您被帐户的管理员授予的 API。

您可以根据需要创建任意数量的访问令牌。出于安全考虑，令牌不会存储在 3scale 中。在创建新令牌时，您将获得保存令牌的警报，以便您可以使用它向 3scale API 发出请求。

如果您丢失了令牌，我们建议您删除它 - 将禁用该令牌并使其无效 - 然后创建一个新令牌。

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

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

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

遵循同一示例，如果您有权访问帐户管理 API，但在进行调用时可以访问零服务，您将收到 访问被拒绝 的错误。

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

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

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

如果您以管理员身份，收到其中一个开发人员有待批准项目的电子邮件通知，您可以将项目的 URL 复制到您的浏览器中，并将您直接转至页面进行批准。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

当您导航到 [Your_product_name] > Applications > Settings > Usages Rules in the Admin Portal 时，您选择的选项决定了用户如何启动更改。下面描述了根据您选择的选项所发生的情况：

当开发人员想要更改开发人员门户上的应用计划时，例如，更改为 Unlimited 计划，该更改将通过电子邮件完成。开发人员必须登录开发人员门户才能完成请求，以更改其计划。

当管理员收到请求更改应用程序计划的电子邮件时，请按照以下步骤完成此过程。它概述了如何选择并确认新计划。另外，开发人员会收到更改通知，允许他们在 Developer Portal 上验证更新。

3scale API 管理会自动向开发人员发送电子邮件通知，通知他们计划更改计划，使用 应用程序计划为购买模板进行了更改。开发人员可以在 Developer Portal 上验证计划更改。

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

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

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

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

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

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

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

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

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

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

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

要搜索给定应用程序，请通过 Audience > Applications > Listing 进入 Applications 页面，并使用下图所示的搜索框。

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

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

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

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

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

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

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

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

向产品或后端添加方法意味着您要在 API 中指定您想要捕获各个使用详情的方法。应用计划为您提供了为您添加到产品或后端的每种方法设置限制的功能。将方法或指标添加到产品的过程类似于向后端添加方法或指标。

添加指标指定您要捕获到 API 的所有调用的使用单元。应用计划提供了为添加到产品或后端的每个指标设置限值的功能。将方法或指标添加到产品的过程类似于向后端添加方法或指标。

如果您的 API 有多个端点，可以通过两种方式自动指定方法并将指标添加到 3scale 产品和后端：

映射规则是映射到之前在产品和后端中创建的方法和指标的操作。

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

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

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

创建完所有计划后，您可以在注册应用程序的人员选择默认计划。

选择默认应用程序计划：

如果没有指明默认的应用计划，当新用户签名以访问您的 API 时，默认情况下不会创建应用程序。换句话说，用户将无法访问您的 API。

第一个决策是区分定价模式中的分层。层可以由卷或使用情况、API 功能、对其他资源的访问或这些资源的组合驱动：

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

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

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

接下来，设置您在 第 21.1 节 “决定您的定价模式” 中选择的定价驱动程序：

如果其中一些已作为指标存在，您可以编辑该项目。

完成设置定价规则后，单击 更新应用程序计划。

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

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

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

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

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

有关创建应用程序计划的详情，请参阅 应用程序计划。

设置速率限值：

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

当您的速率限制正常运行后，您会看到达到仪表板限制的用户，以便快速轻松地检查潜在计划升级候选者。如需有关软限制和硬限制的更多信息，请参阅使用 高级路径配置 API 访问策略 中的入门指南。

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

3scale 的账单基于日历月份，可以 预先支付并支付。

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

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

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

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

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

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

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

借助 currencies.yml 文件，您可以为 3scale 部署配置一个货币列表。3scale 使用基于 ISO 4217 的三字母货币代码。

3scale 中的发票有两种标识符：

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

将发票标识符的计费周期从 monthly 改为 yearly 的唯一影响是更改友好的标识符格式。此修改不会更改计费周期。3scale API 管理仅支持每月账单。如果您的会计部门有此类要求，则可以使用发票标识符的格式。

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

在这里，您可以配置到以下页面的路径：

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

在线支付服务必须在收集信用卡数据时显示强制要求。规定是客户授予您借出其支付方式的权限记录。规定应明确表明，提供的支付方式将用于收集随后的服务付款。有关 stripe 和 Braintree 要求的更多信息，请参阅 其他资源 下面列出的相应支付网关的外部文档链接。

作为 3scale API 提供程序，配置管理门户和开发人员门户，将忽略作为付款网关，以通过使用条带作为信用卡网关从订阅中接收 API 付款。

作为 3scale API 提供程序，配置管理门户和开发人员门户，将忽略作为付款网关，以通过使用 Braintree 作为信用卡网关从订阅中接收 API 付款。

返回至流程。

返回至流程。

返回至流程。

作为 3scale API 提供程序，允许通过开发人员门户支付被拒绝的发票。要启用这些付款，请在管理门户中更新 Invoices 模板。请注意，这个步骤适用于 Developer Portal 的现有实例。

作为使用 Stripe 或 Braintree 作为支付网关的 3scale API 供应商，您可以对这些信用卡网关的某些问题进行故障排除。

定价规则定义每个 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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

您可以在应用程序列表中看到应用程序的试用周期状态([Your_product_name] > Applications > Listing)，在 State 列中作为 live - trial 在 N 天内过期，并在 Trial days left 字段中的应用程序详情页面中看到。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

开发人员可以在开发人员门户的"信用卡详细信息"部分中更改账单地址。管理员无法更改管理门户中的计费地址，但可以使用以下字段作为 其他字段 通过帐户管理 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

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

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

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

配置服务发现后，3scale 扫描在同一 OpenShift 集群中运行的可发现的 API 服务，并自动将关联的 API 定义导入到 3scale 中。另外，3scale 可以根据 OpenAPI 规范(OAS)更新 API 集成及其规格，以将其与集群重新同步。

服务发现提供以下功能：

当您导入可发现的服务时，它会将其命名空间保存在它所属的项目内。导入的服务成为面向客户的新 API、产品及其相应的内部 API 后端。

如果在 OpenShift(OCP)集群中有 3scale 发现 API 服务，则 OCP 服务必须满足以下每个元素的条件：

作为 3scale 管理员，您有两个选项可用于配置服务发现：使用或不使用 Open Authorization(OAuth)服务器。

如果您使用 OAuth 服务器配置 3scale 服务发现，当用户签名到 3scale 时会出现这种情况：

要使用 OAuth 服务器配置服务发现，有以下选项：

如果您在没有 OAuth 服务器的情况下配置服务发现，当用户签入到 3scale 时，该用户不会被重定向。相反，3scale 单服务帐户为集群提供无缝身份验证，以进行服务发现。所有 3scale 租户管理用户对集群具有相同的访问权限级别，同时通过 3scale 发现 API 服务。

作为 3scale 系统管理员，允许用户单独验证并授权 3scale 使用 OpenShift 内置 OAuth 服务器来发现 API。

作为系统管理员，允许用户单独验证 3scale 并授权 3scale 通过 使用红帽单点登录 OpenShift 来发现服务。

有关将 OpenShift 配置为使用 Red Hat 单点登录部署作为 OpenShift 授权网关的示例，您可以参考 此工作流。

要在不使用 OAuth 服务器的情况下配置 3scale 服务发现，您可以使用 3scale 单服务帐户对 OpenShift API 服务进行身份验证。

从 OpenShift 集群中，导入符合 OpenAPI 规范的新 API 服务。此 API 通过 3scale 进行管理。

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

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

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

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

30.1.1. 访问主管理门户

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

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

<MASTER_NAME>.<WILDCARD_DOMAIN>

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

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

30.2.2. 通过 API 调用管理帐户

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

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

user.example.com

标准多租户部署包括：

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

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

恢复帐户后：

3scale 充当您的 API 产品统计的无限可扩展数据存储库。您可以使用指标和方法捕获 API 产品统计信息，以便您可以获得优化管理对 API 的访问所需的信息。例如：

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

选择了要使用的指标后，请使用将指标 添加到产品和后端中所述的步骤在管理门户中注册。

您可以将指标和方法添加到您选择的产品或后端。为他们提供友好的名称和系统名称，3scale 在插件配置中使用。有关创建方法和指标的详情，请参阅指定 方法和添加用于捕获使用详情的指标。

当 3scale 准备好使用您要跟踪的指标的名称时，您需要配置插件来报告这些指标。执行此操作的具体方式取决于所使用的插件或集成方法。默认情况下，插件只报告 Hits、API 事务、指标。

如需有关不同端点的更多信息，请参阅 3scale API 文档，位于管理门户的 Account Settings > Integrate → 3scale API Docs 部分。

您可以查看配置为后端的给定 API 的流量数据。流量 页面显示对端点的点击。

在 API 和 3scale 之间建立连接，以便您可以将流量发送到 API 产品，并在 API 分析仪表板中观察其注册。

除了分析部分的使用情况图外，您还可以使用分析 API 访问分析数据。3scale 分析 API 是一种灵活的方式，能够以 XML 或 JSON 格式提取 API 产品的所有分析数据。

如果 [Your_product_name] > Analytics > Traffic 中的使用图表没有显示流量，请执行以下检查。

一个客户每周上千名新开发人员。该客户可以解决入职的某些方面，因为 3scale 提供关键配置、注册工作流和电子邮件通信等自动化需求。然而，有些问题无法与 3scale 相关，这对于他们而言非常重要。

由于客户入职许多人，公司需要采用直进的方式，根据他们与 API 的合作，对新开发人员进行分类，以便他们的运营和营销团队能够更有效地与新开发人员互动。至少需要的详细信息，3scale 提供的内置分析工具尚不提供此类功能。但是，可以使用 3scale 帐户和分析 API 提取数据，因为系统中所有数据都可用。

首先，他们想要知道注册的开发人员数量，但从未使用过其 API。

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

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

要提取应用程序分析，首先要使用 ActiveDocs。3scale ActiveDocs 在您的管理门户中包括在 Account Settings > Integrate > 3scale API Docs 下。3scale 将其所有 API 都作为 ActiveDocs 提供，因此您可以从浏览器中尝试它们。这样，您可以找到最能满足您需求的请求，获取请求(curl)并获取响应。下图提供了一个 ActiveDocs 示例：

这是 API 请求的 ActiveDocs，用于获取脚本将要提取分析的所有应用的 ActiveDocs。

ActiveDocs 可让您快速了解 API 能够做什么。然后，需要了解您想要执行的任务需要哪 3 个或 4 个请求，并将脚本放在一起。

以下流程演示了实现示例客户所需自定义分析的步骤。