管理条款及条件

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息

简介

您必须先在组织资料中添加条款及条件（“条款及条件”），然后才能发布价格方案。条款及条件位于组织外部 个人资料。在组织资料中，您需要指定 条款及条件。

发布费率方案后，当前版本的条款及条件会显示在 开发者门户开发者只有在接受当前的方案后，才能购买方案 条款及条件。

使用界面添加条款及条件

  1. 访问“组织资料”页面，如探索“组织资料”页面中所述。
  2. 点击修改。
  3. 在“组织资料”页面的“条款及条件”部分，点击添加条款和 条件。

    此时会显示“新建条款及条件”对话框

  4. 输入以下信息：
    字段 说明
    生效日期

    条款及条件的生效日期。默认值为 日期。您必须输入当前日期或将来的日期。
    版本

    条款及条件的版本。通过版本号 不同版本的条款及条件。
    网址

    条款及条件的网址。
  5. 点击创建。

    新的条款及条件已添加到“组织资料”的“条款及条件”部分 页面。

  6. 重复步骤 3 到 5 以添加其他条款和条件。
  7. 点击保存以保存对组织资料的更改。

使用用户界面编辑条款和条件

您无法直接修改条款和条件。您必须删除相应条款 然后再添加一个新的条款及条件条目。

使用界面删除条款及条件

  1. 访问“组织资料”页面，如探索“组织资料”页面中所述。
  2. 点击“组织资料”页面上的修改。
  3. 在条款及条件列表中，将光标悬停在要删除的条款及条件上。
  4. 点击 。

使用 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。例如：

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 的开发者或公司的条款及条件文档

通过发出 POST 为特定开发者或公司接受条款及条件文件 分别发送到以下 API 之一：

  • /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 的开发者或公司接受的条款及条件

通过发出 GET 请求，查看特定开发者或公司接受的条款及条件 分别发送到以下 API 之一：

  • /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 修改条款及条件

向以下用户发出 PUT 请求以修改条款及条件 /mint/organizations/{org_named}/tncs/{tncs_id}，其中 {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 删除条款及条件

向 发出 DELETE 请求以删除条款及条件 /mint/organizations/{org_name}/tncs/{tncs_id}，其中 {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

条款及条件的组织。

 不适用 否

后续步骤

如需了解如何为贵组织最初设置的币种添加受支持的币种，请前往 管理受支持的设备 币种。