术语
了解红帽 3scale API 管理平台中使用的所有术语。
摘要
第 1 章 3scale term 复制链接链接已复制到粘贴板!
本节充当 3scale 平台中使用的常用术语表。
1.1. 访问令牌 复制链接链接已复制到粘贴板!
访问令牌是在调用帐户管理 API、分析 API 和 Billing API 时进行身份验证的密钥。
1.2. ActiveDocs 复制链接链接已复制到粘贴板!
ActiveDocs 是记录 REST API 的 3scale 规格。ActiveDocs 基于流行的 Swagger 框架。使用 ActiveDocs 时,API 获得互动文档,方便开发人员了解 Web 服务并在不安装的情况下对其进行测试。
1.3. 管理员门户 复制链接链接已复制到粘贴板!
在管理门户中,API 提供程序可通过 3scale 配置其 API 集成,管理应用程序计划,提供对内部成员和外部客户的访问权限,并对每个应用程序密钥限制流量。这是 API 供应商中央控制台来管理和保护对其 API 的访问。Admin Portal 包含作为起点的控制面板。
1.4. API 复制链接链接已复制到粘贴板!
API 是一个或多个可访问 的方法 的逻辑捆绑包。给定 API 供应商可以公开一个或多个这样的 API。术语 API 与词语 Service 可互换使用。
3scale 还拥有自己的 API,它位于 3scale ActiveDocs,它位于您的管理门户中,它位于 Documentation → 3scale API Docs 部分。
1.5. APIcast 网关 复制链接链接已复制到粘贴板!
APIcast 是一个基于 NGINX 的 API 网关,用于将您的内部和外部 API 服务与 3scale API 管理平台集成。API 网关是处理 API 请求的接口。根据其配置,它可以处理访问控制、速率限制、安全过滤、日志记录、路由、缓存…
有关 APIcast 及其部署选项(托管、自助管理和不同的配置选项)的更多信息,请查看 APIcast Overview。
1.6. API 凭证 复制链接链接已复制到粘贴板!
凭证是与应用程序关联的一组键、secret 或标识符,允许应用访问 API。凭据采用的形式取决于用于 API 的验证模式。
1.7. API 使用者 复制链接链接已复制到粘贴板!
单个、组或公司访问由 API 供应商提供的 API。术语 可以引用机构以及组织编写的 软件应用程序 以使用 API。给定的组织可能具有一个或多个访问 API 的应用。
1.8. API 密钥 复制链接链接已复制到粘贴板!
API Key 是应用程序允许调用特定 API 的凭证类型。API Keys 是特定类型的 身份验证方法。
- 应用程序 API 键 :在 3scale 上创建新应用程序时生成(通过用户或 API)。提供对 API 的访问。访问的类型由 应用程序计划 决定。
- provider API key :在 3scale 上创建新提供程序帐户时生成。提供对与提供程序帐户关联的 3scale API 的完全访问权限。
我们强烈建议使用服务令牌对服务管理 API 和访问令牌进行身份验证,以针对帐户管理 API、分析 API 和 Billing API 进行身份验证。它们的自定义/限制访问范围使其与使用此供应商 API 密钥相比更加安全。
1.9. API 供应商 复制链接链接已复制到粘贴板!
在我们的文档和指南中,"API 供应商"(3scale 客户)是拥有一个或多个 API 的个人、组或公司,并使用 3scale API 管理平台进行管理。API 供应商可让其 API 可供其机构内部或在第三方开发人员、合作伙伴或公众以外访问其 API。
1.10. Application(应用程序) 复制链接链接已复制到粘贴板!
应用程序是由 API Consumer 开发的一个软件代码来访问 API。应用程序通常已关联在 3scale 系统中,这是 API 的唯一 api 凭证 集合,发送到 API 的调用的流量历史记录(在应用程序创建时捕获的元数据)。应用程序 链接到 开发人员帐户。
1.11. 身份验证 复制链接链接已复制到粘贴板!
身份验证是验证用户身份或服务器访问的过程。此过程前面是确定可访问资源的授权过程。
1.12. 身份验证方法 复制链接链接已复制到粘贴板!
给定 API 使用的技术方案来表达 API 消费者 需要的凭据,以访问 API 上的方法。3scale 内的每个 API 都只能选择一个并只选择一个身份验证模式。
1.13. 基本 URL 复制链接链接已复制到粘贴板!
这是主机 URL,如 https://my-api.com
- 公共基础 URL :这是端点的根,由 API 客户端调用。
- 专用基本 URL :这是 API 后端服务的内部主机。
1.14. 代码插件 复制链接链接已复制到粘贴板!
插件为 3scale API 提供了一个打包程序,它允许 API 访问控制和 API 流量报告,而无需运行其他服务器。插件驻留在支持您的 API 的代码内。该插件调用 3scale API 以进行访问控制和流量报告。
1.15. 部署选项 复制链接链接已复制到粘贴板!
与"集成选项"相同。在 3scale 中,我们通常提到部署 APIcast 网关的方式(而非 3scale API 管理平台)。
1.16. 开发者帐户 复制链接链接已复制到粘贴板!
开发人员帐户是订阅到特定 API 的帐户。Developer Accounts 是应用程序的父项。当新的开发人员订阅 API 时,会自动为其创建一个应用程序,供他们调用订阅的 API。???
1.17. 开发者门户 复制链接链接已复制到粘贴板!
开发人员门户是开发人员订阅 API 的网站。在开发人员门户网站中,开发人员可以管理其订阅,并可访问其 API 密钥、创建应用程序、访问交互式 API 文档(ActiveDoc),查看其 API 消耗等。3scale CMS(开箱即用功能)可让您快速创建开发人员门户,且需要浏览新的客户。
1.18. 端点(API 端点) 复制链接链接已复制到粘贴板!
端点是一个特定的调用或事务,可由 应用 在 API 上进行。方法通常对应于一个特定操作,如获取对象列表或创建新对象。API 通常有多个端点。术语等同于"方法"术语。
1.19. 最终用户 复制链接链接已复制到粘贴板!
1.20. 字段定义 复制链接链接已复制到粘贴板!
从管理员门户网站中的字段定义部分,可以添加和/或创建新字段,用于从内部管理员/成员从开发人员帐户和应用中收集数据。以下是创建新帐户时显示的字段。例如,在开发人员门户网站上的开发人员注册表单中,可以添加其他字段,如示例 'address'。这些字段可选项或必需。
1.21. 集成错误 复制链接链接已复制到粘贴板!
当调用有不正确的 凭证或令牌集合时,或对带有不正确的 Ids( URL)的调用时,集成错误由 3scale 生成。这些错误可能是来自应用程序造成的错误,这些错误可能是来自 API 的 API,也可以是与 3scale 集成 API 的配置错误。???
1.22. 集成选项 复制链接链接已复制到粘贴板!
集成选项(也称为 部署选项 )是可与 3scale 管理平台(NGINX、插件…)集成 API 的可用选项。
1.23. 映射规则 复制链接链接已复制到粘贴板!
映射规则将传入调用从 特定端点 映射到 3scale 中创建的对应方法和指标。
用量跟踪、端点访问和限制基于使用这些映射规则配置的方法和指标[metrics]。???
请参阅有关 映射规则 的文档。
1.24. 方法(API 方法) 复制链接链接已复制到粘贴板!
方法可让您跟踪 3scale 上的 API 使用情况。您可以为 API API 端点上每个 HTTP 方法添加方法。方法基于.默认情况下,在 3scale 上,方法调用会触发内置的 Hits-metric。要跟踪其他类型的事件,您可以添加不同单元报告的指标。各个方法的使用限制和定价规则由每个应用程序 计划中定义。
请参阅我们的文档 定义您的 API(Methods 和指标)。
1.25. 指标 复制链接链接已复制到粘贴板!
指标(metrics)可让您跟踪 API 的具体调用,方法是将它们映射到集成页面的 Mapping Rules 部分中的 Mapping Rules 部分的一个或多个 URL 模式。指标是累计的,不是离散的。3scale 上的内置顶级指标是 Hits。如果需要,可以添加其他顶级指标。
请参阅我们的文档 定义您的 API(Methods 和指标)。
1.26. 货币化 复制链接链接已复制到粘贴板!
术语"Monetization"或"API 货币化"是指基于 API 访问和/或使用情况的支付客户的事实。API 动力可通过 计划进行。
1.27. 计划 复制链接链接已复制到粘贴板!
计划用于授予对特定 API 和 端点 的访问权限,限制流量和利用 API 货币。3scale 具有四种不同类型的计划,它们可单独使用:
1.28. 潜在的升级 复制链接链接已复制到粘贴板!
潜在升级是指触发流量限制警报的开发人员帐户。在流量量方面,这些开发人员帐户可能会升级为满足其需求的计划。
1.29. 定价规则 复制链接链接已复制到粘贴板!
定价规则是逻辑表达式集,用于决定系统中特定事务的成本。要收费您的 API 使用,您将在 计划 内创建价格规则以确定账单和访问级别。请参见如何 调配 Paid Plans。
1.30. 速率限制或用量限制 复制链接链接已复制到粘贴板!
速率限制与某个 计划 关联,是一个逻辑表达式,它根据特定方法、端点或指标的 API 使用者计算使用量阈值。
这些限制在 Application Plans 中配置,您可以在 此处 阅读。
1.31. 服务 复制链接链接已复制到粘贴板!
在 3scale 中,术语 'API' 和 'Service' 都用于引用 API 服务。API 服务是可被访问的一个或多个方法(或 端点)的逻辑捆绑包。给定的 API 供应商可以公开一个或多个这样的 API 服务。
3scale 还在 3scale ActiveDocs 中有 3scale ActiveDocs,可在您的管理门户中包括 Documentation → 3scale API Docs 部分。
1.32. 服务令牌 复制链接链接已复制到粘贴板!
服务令牌是在调用 3scale Service Management API 时进行身份验证的密钥。
1.33. 订阅 复制链接链接已复制到粘贴板!
帐户和服务之间的合同(计划)
1.34. Swagger 复制链接链接已复制到粘贴板!
请参阅 ActiveDocs。
1.35. Webhook 复制链接链接已复制到粘贴板!
Webhook 是在事件后触发的进程,Webhook 充当即时通知机制。
参阅 Webhook 的文档。