您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 info
如果您想更好地控制参与获利 API 计划的公司和开发者(例如,如果您想创建内部公司和开发者以进行 101} 测试),则可以使用管理界面和 API 手动创建公司和开发者。
手动创建公司和开发者时,主要考虑因素是 开发者是否需要凭据才能登录管理界面、在对 Edge 管理 API 的调用中发送 凭据或登录开发者门户。
- 如果您的获利开发者需要登录凭据才能访问 Edge 界面或 API,则他们必须先拥有自己的 Apigee 管理员账号。
- 如果您只需要创建不需要凭据的测试开发者(例如,如果您想使用虚构的测试开发者进行 API 调用),则不需要 Apigee 账号。
使用界面管理应用开发者
使用 Edge 界面创建、管理和激活应用开发者,如管理应用开发者中所述。 创建应用开发者后,您可以将他们添加到公司,如以下部分所述。
使用界面管理公司
创建、管理和激活公司,如以下部分所述。
浏览“公司”页面
访问“公司”页面(如下所述)。
Edge
如需使用 Edge 界面访问“公司”页面,请执行以下操作:
- 登录 apigee.com/edge。
- 在左侧导航栏中选择发布 > 获利 > 公司 。
系统会显示“公司”页面。

如图所示,您可以通过“公司”页面执行以下操作:
经典版 Edge (Private Cloud)
如需使用经典版 Edge 界面访问“公司”页面,请执行以下操作:
- 登录
http://ms-ip:9000,其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。 - 在顶部导航栏中选择发布 > 公司 。
系统会显示“公司”页面。

- 查看当前公司列表
- 管理公司。具体来说,添加、激活、修改和删除公司。
- 查看已连接的开发者门户(仅限 Drupal 7)
添加公司
如需添加公司,请执行以下操作:
- 访问“公司”页面。
- 点击 + 公司。
- 输入公司详细信息。
必填字段包括:
- 公司名称
- 管理员(作为主要公司 管理员的用户)
- 结算类型
根据创收结算配置,结算类型可能会默认为
PREPAID或POSTPAID。如需了解详情,请参阅使用 API 配置预付费和后付费结算类型。 - 向公司添加一个或多个开发者。
- 在“开发者”部分中,在添加开发者 字段中输入一个字符串,以显示与该字符串匹配的开发者列表。
- 从下拉列表中选择一个开发者。
- 重复上述步骤,向公司添加其他开发者。
- 添加一个或多个自定义属性。
- 在“自定义属性”部分中,点击 + 新建。
- 输入自定义属性的名称和值。
- 重复上述步骤,向公司添加其他自定义属性。
- 点击创建公司 。
激活和停用公司
如需激活和停用公司,请执行以下操作:
- 访问“公司”页面。
- 将光标置于要激活的公司上,然后在操作菜单中启用
。
停用该切换开关以停用公司。
修改公司
如需修改公司,请执行以下操作:
- 访问“公司”页面。
- 将光标置于要修改的公司上,然后点击操作菜单中的
。 - 根据需要更新公司详细信息。
- 点击更新公司 以保存更改。
删除公司
如需删除公司,请执行以下操作:
- 访问“公司”页面。
- 将光标置于要删除的公司上,然后点击操作菜单中的
。 - 点击删除 以确认删除操作。
使用 API 管理公司和开发者
以下部分介绍了如何使用 API 管理公司和开发者。
使用 API 创建和更新公司和开发者
如需使用 API Edge 管理 API 管理公司和开发者,请参阅以下 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 软件包 | |
| 创建开发者费率方案 | |
| 查看开发者可用的费率方案 | |
| 查看特定开发者可用的费率方案,其中包含特定 产品 | |
| 只能查看接受的开发者费率方案 | |
| 向开发者发放赠金 | |
| 为开发者设置赠金限额 | |
| 查看开发者赠金限额 | |
| “充值”(向)开发者的预付款余额 | |
| 查看开发者的预付款余额 | |
| 为开发者设置通知条件 | |
| 为开发者创建和查看报告定义 |