您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。信息
开发者类别是一组具有类似特征的开发者或公司,允许您配置创收功能以在该特定类别上运行。例如,您可以创建名为“revenue_sharing”的开发者类别,并将开发者添加到该类别中,从而创建适用于所有开发应用以进行收益分成的开发者的费率方案。如需详细了解如何创建包含开发者类别的费率方案,请参阅创建费率方案。
探索“开发者类别”页面
使用 Edge 界面或 Classic Edge 界面访问“开发者类别”页面,如以下部分所述。
Edge 界面
如需访问“开发类别”页面,请执行以下操作:
- 登录 apigee.com/edge。
- 在左侧导航栏中依次选择发布 > 创收 > 开发者类别。
系统随即会显示“开发者类别”页面。
如图所示,您可以通过“开发者类别”页面执行以下操作:
传统边缘(私有云)
如需使用经典 Edge 界面访问“开发类别”页面,请执行以下操作:
- 登录
http://ms-ip:9000
,其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。 - 在顶部导航栏中选择发布 > 开发者类别。
系统会显示“开发者类别”页面。
在“开发者类别”页面中,您可以执行以下操作:
添加开发者类别
如需使用界面添加开发者类别,请执行以下操作:
- 访问“开发类别”页面。
- 点击 + 开发者类别。
- 输入新类别的名称和简短说明。
- 点击创建开发者类别。
向开发者类别添加公司
将公司添加到开发者类别。一家公司只能属于一个开发者类别。
如需向开发者类别添加公司,请执行以下操作:
- 在顶部导航栏中,依次选择发布 > 公司。
- 选择要添加到开发者类别的公司。
- 点击公司页面上的修改。
- 为公司选择开发者类别。
- 点击保存。
修改开发者类别
如需使用界面修改开发者类别,请执行以下操作:
- 访问“开发类别”页面。
- 将光标置于要修改的开发者类别上,然后点击 。
- 输入开发者类别。
- 点击更新开发者类别。
删除开发者类别
如需使用界面删除开发者类别,请执行以下操作:
- 访问“开发类别”页面。
- 将光标置于要修改的开发者类别上。
- 点击 。
- 点击删除以确认操作。
使用 API 管理开发者类别
使用 API 管理开发者类别,如以下部分所述。
使用 API 添加开发者类别
通过向 /mint/organizations/{org_name}/developer-categories
发出 POST 请求来添加开发者类别。
发出请求时,您可以在载荷中指定类别 name
和 description
。例如:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \ -H "Content-Type:application/json" \ -d '{ "name": "Gold", "description": "Gold membership" }' \ -u email:password
应返回如下所示的内容:
{ "description" : "Gold membership", "id" : "aa6f960a-d9fd-416e-be39-c071418aabd0", "name" : "Gold" }
使用 API 将开发者或公司添加到开发者类别
在添加或修改公司或开发者时,您可以通过分别向以下资源发出 POST 请求,将开发者或公司添加到开发者类别:
- /organizations/{org_name}/companies
- /organizations/{org_name}/developers
如需在修改公司或开发者时将开发者或公司添加到开发者类别,请分别向以下资源发出 PUT 请求:
- /organizations/{org_name}/companies/{company_id}
- /organizations/{org_name}/developers/{developer_id}
公司或开发者只能属于一个开发者类别。
在请求正文中将 MINT_DEVELOPER_CATEGORY
指定为属性,并将类别内部 ID 作为值。例如,以下请求会将现有开发者添加到名为“Gold”且 ID 为 aa6f960a-d9fd-416e-be39-c071418aabd0
的开发者类别中。
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/K4jW2QLjZ1h8GFA8" \ -H "Content-Type: application/json" \ -d '{ "email" : "developer@apigee.com", "developerId" : "K4jW2QLjZ1h8GFA8", "firstName" : "Dev", "lastName" : "One", "userName" : "devone", "attributes" : [ { "name" : "MINT_REGISTRATION_ID", "value" : "dev1" }, { "name" : "MINT_DEVELOPER_LEGAL_NAME", "value" : "DEV ONE" }, { "name" : "MINT_DEVELOPER_TYPE", "value" : "TRUSTED" }, { "name" : "MINT_BILLING_TYPE", "value" : "PREPAID" }, { "name" : "MINT_IS_BROKER", "value" : "TRUE" }, { "name" : "MINT_DEVELOPER_CATEGORY", "value" : "aa6f960a-d9fd-416e-be39-c071418aabd0" }, { "name" : "MINT_DEVELOPER_ADDRESS", "value" : "{ "address1": "Dev One Address", "city": "Pleasanton", "country": "US", "isPrimary": "true", "state": "CA", "zip": "94588" }" } }' \ -u email:password
使用 API 查看开发者类别
查看组织中的特定开发者类别或所有开发者类别。
您可以通过向 /mint/organizations/{org_name}/developer-categories/{category_id}
发出 GET 请求来查看特定开发者类别,其中 {category_id}
是相应开发者类别的标识(添加开发者类别后,此 ID 会在响应中返回)。例如:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Accept:application/json" \ -u email:password
向 /mint/organizations/{org_id}/developer-categories
发出 GET 请求,即可查看某个组织的所有 API 开发者类别。例如:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \ -H "Accept:application/json" \ -u email:password
使用 API 修改开发者类别
您可以通过向 /mint/organizations/{org_name}/developer-categories/{category_id}
发出 PUT 请求来修改开发者类别,其中 {category_id}
是要更新的类别的标识。您需要在请求正文中指定更新后的设置以及开发者类别的 ID。例如,以下请求会修改开发者类别的说明:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Content-Type: application/json" \ -d '{ "id": "aa6f960a-d9fd-416e-be39-c071418aabd0", "description": "Premium membership" }' \ -u email:password
使用 API 删除开发者类别
向 /mint/organizations/{org_name}/developer-categories/{category_id}
发出 DELETE 请求以删除开发者类别,其中 {category_id}
是要删除的开发者类别的标识。例如:
curl -X DELETE "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Accept:application/json" \ -u email:password
API 的开发者类别配置属性
下表总结了可使用此 API 设置的配置属性。
名称 | 说明 | 默认值 | 是否必需? |
---|---|---|---|
name |
房源名称。设置为 MINT_DEVELOPER_CATEGORY。 |
不适用 | 是 |
value |
添加开发者所属的开发者类别的 ID。 |
不适用 | 是的,以便设置开发者类别。 |