您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
其中有几项在 Apigee 中具有独特意义的常见概念。
| 术语 | 定义 |
|---|---|
| API | 充当现有 API Facade 的代理。开发者不会调用现有 API，而是开始调用 Apigee 生成的新 API。这种 Facade 会使您的公共接口与后端 API 分离，从而保护开发者免受后端更改的影响，同时可让您在边缘进行创新，而不会影响内部开发团队。当您更改后端时，开发者会继续调用相同的 API，而不会中断。在更高级的场景中，Apigee 允许您向同一 API 中公开多个接口，从而免去自定义 API 的签名，以满足不同开发者群体的需求。 |
| API 基本路径和资源 | API 由基本路径和一组资源（也称为资源路径）组成。为每个 API 定义单个根网址和多个资源路径。您可以将 API 简单地视为一组 URI，所有 URI 共用一个基本路径。为了让您更轻松地管理 API，Apigee 使用显示名和描述来增强这些原始 URI。 |
| API 使用方 | 与“应用开发者”同义，使用 API 提供方创建的 API。 |
| API 开发者 | 构建 API 的 API 提供方组织中的软件工程师。应用开发者（API 使用方）使用这些 API 构建应用。 |
| API 套餐 | 以软件包形式向开发者提供的 API 产品的集合，通常与价格方案相关联。 |
| API 产品 | 与服务计划组合并以软件包形式提供给开发者的 API 资源 (URI) 集合。API 产品还可以包含特定于您的业务的元数据，用于进行监控或分析。您可以通过将一个或多个资源添加到 API 产品来获利，然后可以将这些资源绑定到 API 软件包以实现获利。 |
| API 提供方 | API 提供方构建 API（使用 Edge），供 API 使用方（应用开发者）使用。 |
| 应用开发者 | 在 Edge 中，应用开发者向 API 提供方注册他们的应用，同时应用开发者需要获取调用提供方 API 代理所需的 API 密钥。 |
| 应用 | 开发者使用应用来访问 API 产品中的资源。在创建应用时，您可选择要添加的 API 产品，Apigee 会生成密钥。每个应用都有一个密钥，可让您访问多个 API 产品。通过应用，您可以控制哪些用户可以访问您的资源。您可以通过撤消和刷新应用密钥来控制谁有权访问您的 API 产品。此外，您可以通过撤消或删除对应用中产品的访问权限来控制对资源软件包的访问权限。 |
| 余额明细 | 对于预付费开发者，这是开发者账号的余额。 |
| 已关闭调整 | 在发布的结算文档中应用的调整。 |
| 已关闭结算月份 | 发布了结算文档的完整日历月。 |
| 自定义限制 | 可以使用获利显式设置的限制（例如对 API 产品的交易数限制）。也称为显式限制。 |
| 开发者类别价格方案 | 适用于特定类别的所有开发者且可供该类别的所有开发者购买的价格方案。 |
| 开发者价格方案 | 适用于特定开发者且仅可供该开发者购买的价格方案。 |
| 披露代理 | 在商法中，有权代表另一方（称为“主账号”）与第三方建立法律关系的人员。在获利过程中，您可以为收益分成方案设置税费模型，这样 API 提供方可充当开发者的披露代理，以代表开发者收取收益（和可能的销售税）。 |
| 披露税费模型 | 一种税费模型，其中 API 提供方充当开发者的披露代理。 |
| 环境 | API 的运行时执行上下文。必须将 API 部署到环境中，才能在运行时访问。默认情况下，Apigee 组织预配了两个环境：“test”和“prod”。“test试”环境通常用于部署接受测试的 API。“prod”环境通常用于部署 API 供生产环境使用。 |
| 混合税费模型 | 一种税费模型，其中 API 提供方充当开发者的披露代理。但是，API 提供方可代表开发者向当地税务部门缴纳从其订阅者中收取的销售税。 |
| 隐式限制 | 通过获利设置的限制（例如开发者预付费余额限制）。 |
| 获利 | Apigee Edge Developer Services 的一个组件，可提供一种简单灵活的方式实现 API 产品获利。 |
| 每月使用费 | 开发者在给定月份的总使用费，包括设置费 + 交易费 + 经常性费用。 |
| 按月付款 | 开发者根据所购买的方案进行的经常性付款。无论使用费如何，价格方案均可每月向开发者收取经常性费用。 |
| 净额结算报表 | 显示账单和收益分成报表之间的净余额的财务文档。 |
| 打开调整 | 尚未在发布的结算文档中应用的调整。 |
| 打开结算月份 | 尚未发布“最终”结算文档的完整日历月。 |
| 组织 | 用于存储 Apigee 账号中的所有对象（包括 API、API 产品、API 软件包、应用和开发者）的容器。您可能加入的每个组织都需要一个用户账号。（大多数用户只能在一个组织中拥有一个账号。）提交每个 API 请求时，您都必须提供凭据（用户名和密码）以及贵组织的名称。 |
| 软件包目录 | API 软件包列表。每个软件包都列有其 API 产品和价格方案。 |
| 预付款余额 | 预付费开发者可用于提前支付 API 软件包的金额。 |
| 预付费开发者 | 提前支付 API 产品使用费的开发者。使用 API 产品时将从预付费开发者的余额中扣除相应资金。开发者必须保持足够预付款余额才能购买 API 产品。API 提供方会为开发者分配预付费或后付费状态。 |
| 政策 | 一项处理步骤，作为 API 流中可重复使用的原子化逻辑单元执行。典型的政策包括：将请求路由到正确的端点、转换消息格式、强制执行访问权限控制、调用远程服务获取其他信息、遮盖来自外部用户的敏感数据、检查消息内容是否存在潜在威胁、缓存常见响应来改善性能等。可以根据请求或响应消息的内容或上下文有条件地执行政策。例如，如果请求消息从智能手机发出，则可以执行转换政策以自定义响应格式。 |
| 后付费开发者 | 按月结算（通过账单）API 产品使用费的开发者。开发者根据账单中包括的方案设置的付款条件支付 API 产品使用费。API 提供方会为开发者分配后付费或预付费状态。 |
| 价位 | 可能出售的可能价格范围。 |
| 价目表价格方案 | 据以向开发者收费的价格方案，涉及获利 API 产品的每笔交易都有固定或可变价格。 |
| 价格方案 | 获利 API 软件包中提供的 API 产品的使用费用、其他费用和收益分成的规范。 |
| 资源路径 |
一项 RESTful 概念，资源路径是对访问给定资源的网络路径进行标识的统一资源标识符 (URI)。 |
| 收益分成价格方案 | 一种价格方案，其中将与发出请求的应用的开发者分成涉及获利 API 产品的每笔交易所产生收益的一定百分比。 |
| 收益分成和价目表方案 | 一种价格方案，其中将与发出请求的应用的开发者分成涉及获利 API 产品的每笔交易所产生收益的一定百分比。对于每次交易，还会向开发者收取固定或可变费用。 |
| 自行结算账单 | 生成的财务文档，而非收益分成报表。它详细说明了开发者应付的金额，并充当代表开发者向 API 提供方开具的账单。 |
| 标准价格方案 | 可供所有开发者购买的价格方案。 |
| tax | 适用于开发者的使用费和费用的总税费。 |
| 充值 | 预付费开发者执行以增加预付款余额中的资金的操作。 |
| 交易记录政策 | 一种使获利功能能够捕获交易参数和自定义属性的机制。获利功能需要这些信息才能执行其获利处理，例如根据每项交易中捕获的自定义属性向 API 请求和响应应用价格方案。 |
| 未披露代理 | 参与应用基础供应以致被视为代表开发者购买内容（仅出于税费目的）的组织（或运营方）。作为未披露代理，组织（或运营商）可以收取并说明最终用户应缴纳的税费。此状态仅适用于税费，即开发者在供应链中的法律地位不受影响。 |
| 未披露税费模型 | 一种税费模型，其中 API 提供方会扣除从最终用户处收取的税费并将其支付给当地税务部门。 |
| 版本 | 面向开发者的 API 接口版本。例如，pivotaltracker.com/services/v3 或 api.enterprise.apigee.com/v1。应将该术语与“修订版本”加以区分，后者是捆绑到 API 代理中已编号且受版本控制的配置和策略软件包。简而言之，API 接口具有版本，而 API 代理具有修订版本。 |