使用 Edge 管理公司和开发者

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

如果您希望对参与创收 API 计划的公司和开发者拥有更多控制权(例如,您希望出于测试目的创建内部公司和开发者),可以使用管理界面和 API 手动创建公司和开发者。

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

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

使用界面管理应用开发者

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

使用界面管理公司

请按照以下部分所述创建、管理和激活公司。

探索“公司”页面

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

Edge

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

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

此时会显示“公司”页面。

如图所示,在“Companies”(公司)页面,您可以执行以下操作:

传统 Edge (Private Cloud)

如需使用传统版 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. 点击 Create company(创建公司)。

激活和停用公司

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

  1. 访问“Company”(公司)页面
  2. 将光标放在要启用的公司上方,并在操作菜单中启用
    停用切换开关即可停用公司。

修改公司

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

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

删除公司

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

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

使用 API 管理公司和开发者

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

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

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

使用 API 管理开发者角色

您可以使用 Monetize 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 检索信用额度

为开发者的预付款余额“充值”(充值)

管理预付款账号余额

查看开发者的预付款余额

查看开发者的预付款帐号余额

为开发者设置通知条件

使用通知模板设置通知

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

管理报告