您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
简介
您必须先向组织资料添加条款及条件(简称“T&C”),然后才能发布费率方案。相应条款及条件位于组织个人资料之外。在组织个人资料中,您可以指定条款及条件的网址(公开网址)。
发布费率方案后,开发者门户中会显示当前版本的条款及条件。开发者只有在接受当前条款及条件后才能购买方案。
使用界面添加条款及条件
- 按照探索“组织资料”页面中所述,访问“组织资料”页面。
- 点击修改。
- 在“组织资料”页面的“条款及条件”部分,点击添加条款及条件。
系统会显示“新条款及条件”对话框
- 输入以下信息:
字段 说明 生效日期 相应条款及条件的生效日期。默认值为当前日期。您必须输入当前日期或未来日期。
版本 相应条款及条件的版本。版本号可让您跟踪不同版本的条款及条件。
网址 条款及条件的网址。
- 点击创建。
新条款及条件会添加到“组织资料”页面的“条款及条件”部分。
- 重复第 3 步到第 5 步,添加其他条款及条件。
- 点击保存以保存组织资料更改。
使用界面修改条款及条件
您无法直接修改条款及条件。您必须删除要修改的条款及条件,然后添加新的条款及条件条目。
使用界面删除条款及条件
- 按照探索“组织资料”页面中所述,访问“组织资料”页面。
- 点击“组织资料”页面上的修改。
- 在条款及条件的列表中,将光标放在要删除的条款及条件上。
- 点击
。
使用 API 管理条款及条件
使用 API 管理条款及条件,如以下部分所述。
使用 API 添加条款及条件
如需添加条款及条件,请向 /mint/organizations/{org_name}/tncs 发出 POST 请求。
添加条款及条件时,您可以选择指定以下内容:
- 网址
- 随附文字(例如说明)
- 相应条款及细则的生效日期
- 版本号
如需详细了解这些选项,请参阅“条款及条件”配置属性。
例如:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-H "Content-Type: application/json" \
-d \
'{
"url":"www.testoperator/termsandconditions",
"tncText":"Sample text for the T&C",
"version":"1.1",
"startDate":"2018-09-24"
}' \
-u email:password
以下提供了一个响应示例:
{
"id" : "6803d70a-18cc-40c8-b250-675c5e8a75c ",
"organization" : {
…
},
"startDate" : "2018-09-24 00:00:00",
"tncText" : "Sample text for the T&C",
"url" : "www.testoperator/termsandconditions",
"version" : "1.1"
}使用 API 查看条款及条件
查看特定条款及条件或组织的全部条款及条件。
通过向 /mint/organizations/{org_name}/tncs/{tncs_id} 发出 GET 请求来查看特定服务条款,其中 {tncs_id} 是特定服务条款的标识(创建服务条款时,系统会在响应中返回相应 ID)。例如:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
-H "Accept: application/json" \
-u email:password
通过向 /mint/organizations/{org_name}/tncs 发出 GET 请求,查看组织的所有条款及条件。例如:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-H "Accept: application/json" \
-u email:password
以下提供了一个响应示例:
{
"tnc" : [
{
"id" : "77193339-8d79-44a8-8af2-3593f16c158e",
"organization" :
{
...
},
"startDate" : "2018-07-01 00:00:00",
"tncText" : "Big operator text for the T&C",
"url" : "www.bigoperator/termsandconditions",
"version" : "1.0"
},
{
"id" : "6803d70a-18cc-40c8-b250-675c5e8a75c3",
"organization" : {
...
},
"startDate" : "2018-09-24 00:00:00",
"tncText" : "Sample text for the T&C",
"url" : "www.testoperator/termsandconditions",
"version" : "1.1"
}
]
"totalRecords" : 2
}使用 API 接受开发者或公司的条款及条件文档
如需接受特定开发者或公司的条款及条件文档,请分别向以下 API 发出 POST 请求:
/mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs
其中,{dev_id} 是开发者 ID(电子邮件地址),{company_id} 是公司 ID,{tncs_id} 是条款及条件文档 ID。
例如:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/tncs/5a291b86-42e3-4ae1-8db3-efe4b0877316/developer-tncs" \
-H "Content-Type: application/json" \
-d \
'{
"action":"ACCEPTED",
"auditDate":"2018-10-01 00:00:00"
}' \
-u email:password
以下提供了一个响应示例:
auditDate 设置为世界协调时间 (UTC) 的当前时间。{ "action": "ACCEPTED", "auditDate": "2018-10-01 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316", ... } }
使用 API 查看开发者或公司接受的条款及条件
如需查看特定开发者或公司接受的条款及条件,请分别向以下 API 发出 GET 请求:
/mint/organizations/{org_name}/developers/{dev_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/developer-tncs
其中,{dev_id} 是开发者 ID(电子邮件地址),{company_id} 是公司 ID。
例如:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/developer-tncs" \
-H "Accept:application/json" \
-u email:password
以下提供了一个响应示例:
{ "developerTnc": [ { "action": "ACCEPTED", "auditDate": "2018-08-29 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "26abc14c-c628-4c38-8840-a343c8ee9437", ... } }], "totalRecords": 1 }
使用 API 修改条款及条件
通过向 /mint/organizations/{org_named}/tncs/{tncs_id} 发出 PUT 请求来修改条款及条件,其中 {tncs_id} 是条款及条件的标识。进行更新时,您需要在请求正文中指定更新后的设置以及相应条款及条件的标识。例如,以下请求会修改相应条款及条件的版本号(示例中突出显示的属性是更新后的属性):
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/cfbb03b3-b707-495b-9b8a-ff67d71065a9" \
-H "Content-Type: application/json" \
-d {
"id":"6803d70a-18cc-40c8-b250-675c5e8a75c",
"version":"1.2"
}' \
-u email:password
以下提供了一个响应示例:
{ "id" : "cfbb03b3-b707-495b-9b8a-ff67d71065a9", "organization" : { "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], …" }, "startDate" : "2018-09-24 00:00:00", "tncText" : "Sample text for the T&C", "url" : "www.testoperator/termsandconditions", "version" : "1.2" }
使用 API 删除条款及条件
如需删除条款及条件,请向 /mint/organizations/{org_name}/tncs/{tncs_id} 发出 DELETE 请求,其中 {tncs_id} 是条款及条件的标识。例如:
curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \ -H "Accept: application/json" \ -u email:password
API 的条款及条件配置属性
下表总结了可使用 API 为条款及条件设置的配置属性。
| 名称 | 说明 | 默认值 | 是否必需? |
|---|---|---|---|
url |
相应条款及条件的网址。 |
不适用 | 否 |
tncText |
条款及条件的文本(例如简短说明)。 |
不适用 | 否 |
version |
相应条款及条件的版本。版本号可让您跟踪不同版本的条款及条件。 |
不适用 | 是 |
startDate |
相应条款及条件的生效日期。 |
不适用 | 是 |
organization |
相应条款及条件的组织。 |
不适用 | 否 |
后续步骤
如需了解如何向组织最初设置的币种中添加支持的币种,请参阅管理支持的币种。