使用 Edge 管理公司和开发者

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档
信息

如果您想更好地控制参与创收型 API 计划的公司和开发者(例如,如果您想出于测试目的创建内部公司和开发者),可以使用管理界面和 API 手动创建公司和开发者。

确定您是否需要手动创建公司和开发者的主要考虑因素是,开发者是否需要凭据才能登录管理界面、在调用 Edge 管理 API 时发送凭据,或登录开发者门户。

  • 如果您的变现开发者需要登录凭据才能访问 Edge 界面或 API,则必须先拥有自己的 Apigee 管理员账号。
  • 如果您只需创建不需要凭据的测试开发者(例如,您想使用虚构的测试开发者进行 API 调用),则无需 Apigee 账号。

使用界面管理应用开发者

使用 Edge 界面创建、管理和激活应用开发者,如管理应用开发者中所述。 创建应用开发者后,您可以将其添加到公司,如以下部分所述。

使用界面管理公司

创建、管理和启用公司,如以下部分所述。

探索“公司”页面

访问“公司”页面,如下所述。

Edge

如需使用 Edge 界面访问“公司”页面,请执行以下操作:

  1. 登录 apigee.com/edge
  2. 在左侧导航栏中依次选择发布 > 创收 > 公司

系统会显示“公司”页面。

如图所示,您可以通过“公司”页面执行以下操作:

传统边缘(私有云)

如需使用 Classic Edge 界面访问“公司”页面,请执行以下操作:

  1. 登录 http://ms-ip:9000,其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。
  2. 在顶部导航栏中选择发布 > 公司

系统会显示“公司”页面。

  • 查看当前的公司列表
  • 管理公司。具体而言,可以添加、激活、修改和删除公司。
  • 查看关联的开发者门户(仅限 Drupal 7)

添加公司

如需添加公司,请执行以下操作:

  1. 访问“公司”页面
  2. 点击 + 公司
  3. 输入公司详细信息。

    必填字段包括:

    • 公司名称
    • 管理员(主要公司管理员)
    • 结算类型

    结算类型可能会默认为 PREPAIDPOSTPAID,具体取决于创收结算配置。如需了解详情,请参阅使用 API 配置预付费和后付费结算类型

  4. 向公司添加一个或多个开发者。
    1. 在“开发者”部分,在添加开发者字段中输入字符串,以显示与该字符串匹配的开发者列表。
    2. 从下拉列表中选择开发者。
    3. 重复执行此操作,为公司添加其他开发者。
  5. 添加一个或多个自定义属性。
    1. 在“自定义属性”部分中,点击 + 新建
    2. 输入自定义属性的名称和值。
    3. 重复此操作,为公司添加其他自定义属性。
  6. 点击创建公司

激活和停用公司

如需激活和停用公司,请执行以下操作:

  1. 访问“公司”页面
  2. 将光标置于要启用的公司上,然后在操作菜单中启用
    停用该切换开关以停用公司。

修改公司

如需修改公司,请执行以下操作:

  1. 访问“公司”页面
  2. 将光标置于要修改的公司上,然后点击操作菜单中的
  3. 根据需要更新公司详细信息。
  4. 点击更新公司以保存更改。

删除公司

如要删除公司,请执行以下操作:

  1. 访问“公司”页面
  2. 将光标置于要删除的公司上,然后点击操作菜单中的
  3. 点击删除以确认删除操作。

使用 API 管理公司和开发者

以下部分介绍了如何使用 API 管理公司和开发者。

使用 API 创建和更新公司和开发者

如需使用 API Edge Management API 管理公司和开发者,请参阅以下 API 部分:

使用 API 管理开发者角色

您可以使用创收 API 创建角色。这样,您就可以为合作伙伴建立角色。例如,您可以为合作伙伴创建管理员和应用开发者角色。然后,您可以将这些角色分配给特定的合作伙伴员工。

创建开发者角色

如需创建开发者角色,请向 organizations/{org_name}/developer-roles 发出 POST 请求。发出请求时,您需要在请求正文中指定角色的名称和说明,以及组织的标识。例如:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}"
   }
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

检索开发者角色

如需检索开发者角色,请向 organizations/{org_id}/developer-roles 发出 GET 请求。 例如:

$ curl -H "Accept:application/json" -X GET \
"https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

响应应类似如下所示(仅显示部分响应):

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

API 的开发者角色配置设置

以下开发者角色配置选项会公开给 API:

名称 说明 默认值 是否必需?
name

开发者角色的名称。

不适用
description

开发者角色的说明。

不适用

使用 API 检索开发者的税率

您可以向 organizations/{org_name}/tax-engine 发出 GET 请求,获取开发者的当前税率。发出请求时,您需要将开发者的标识作为查询参数指定。例如:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u email:password

应返回如下所示的内容:

0.09

使用 API 执行其他开发者专用任务

您可以为组织执行的许多与创收相关的任务(例如创建费率方案或创建通知条件)也可以为个人开发者执行。例如,您可以为特定开发者创建银行账户,或为特定开发者生成收入报告。

下表列出了您可以使用变现 API 执行的开发者专用任务。该表格还列出了有关执行这些任务的详细说明所在的位置。

任务 在哪里可以找到说明
查看开发者接受的条款及条件

查看使用该 API 的开发者或公司接受的条款及条件

查看开发者接受的 API 软件包

查看使用该 API 的开发者或公司接受的 API 产品套装

创建开发者费率方案

管理费率方案

查看可供开发者使用的费率方案

浏览“费率方案”页面

查看面向特定开发者提供的包含特定产品的费率方案

使用 API 查看包含 API 产品的开发者接受的费率方案

仅查看接受的开发者费率方案

使用 API 查看开发者接受的所有费率方案

向开发者发放代金券

发放赠金

为开发者设置信用额度

使用 API 设置信用额度

查看开发者赠送金额上限

使用 API 检索信用额度

向开发者的预付费余额“充值”(增加金额)

管理预付费账号余额

查看开发者的预付费余额

查看开发者的预付费账号余额

为开发者设置通知条件

使用通知模板设置通知

为开发者创建和查看报告定义

管理报告