本頁面由 Cloud Translation API 翻譯而成。

管理條款及細則

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。資訊

簡介

你必須在機構資料中新增條款及細則 (下稱「條款及細則」)，才能發布費率方案。條款及細則在機構資料外部。在機構設定檔中，您可以指定條款及細則的位置 (公開網址)，

發布費率方案後，開發人員入口網站就會顯示現行的條款及細則版本。開發人員必須先接受目前的條款及細則，才能購買方案。

透過 UI 新增條款及細則

前往「機構資料」頁面，方法如探索「機構資料」頁面。
按一下「編輯」。
在「機構資料」頁面的「條款及細則」部分中，按一下「新增條款及細則」。
系統會顯示「新增條款及細則」對話方塊

輸入下列資訊：

欄位	說明
生效日期	條款及細則的生效日期。預設值為目前的日期。請輸入目前或未來的日期。
版本	條款及細則的版本。版本號碼可讓您追蹤不同版本的條款及細則。
網址	條款及細則的網址。

按一下「Create」(建立)。
「機構個人資料」頁面的「條款及細則」一節中會新增條款及細則。
重複步驟 3 到 5，新增其他條款及細則。
按一下「儲存」，儲存機構付款資料變更內容。

透過 UI 編輯條款及細則

您無法直接編輯條款及細則。但必須刪除要編輯的條款及細則，然後新增條款及細則項目。

透過 UI 刪除條款及細則

前往「機構資料」頁面，方法如探索「機構資料」頁面。
按一下「機構個人資料」頁面上的「編輯」。
在條款及細則清單中，將滑鼠遊標移到要刪除的條款及細則上。
按一下「」。

使用 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 會設為世界標準時間的「目前時間」。

{
  "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 要求，藉此刪除 T&C，其中 {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`	條款及細則組織。	不適用	否

後續步驟

如要瞭解如何為貴機構一開始設定的貨幣新增支援的貨幣，請參閱「管理支援的貨幣」。