管理條款及細則

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

簡介

您必須先在機構設定檔中新增條款及細則 (「T&C's」),才能發布費率方案。使用者條款位於機構設定檔之外。在貴機構的機構檔案中,您可以指定條款與細則的位置 (公開網址)。

發布費率方案後,開發人員入口網站會顯示目前的條款及細則版本。開發人員必須接受目前的《服務條款》,才能購買方案。

透過 UI 新增條款及細則

  1. 前往「機構個人資料」頁面,如「探索機構個人資料頁面」所述。
  2. 按一下「編輯」
  3. 在「機構資料」頁面的「條款及細則」部分中,按一下「新增條款及細則」

    畫面上會顯示「New terms and conditions」對話方塊

  4. 輸入下列資訊:
    欄位 說明
    生效日期

    條款及細則生效日期。預設值為目前日期。您必須輸入目前或未來的日期。

    版本

    條款及細則版本。版本號碼可讓您追蹤不同版本的條款及細則。

    網址

    條款及細則的網址。

  5. 按一下「建立」

    新的條款及細則會加入「機構個人資料」頁面的「條款及細則」部分。

  6. 重複執行步驟 3 到 5,新增其他條款及細則。
  7. 按一下「儲存」,儲存機構設定檔的變更。

使用 UI 編輯條款及細則

您無法直接編輯條款和條件。您必須先刪除要編輯的條款及細則,再新增條款及細則項目。

使用 UI 刪除條款及細則

  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 (您建立條款及細則時,系統會在回應中傳回該 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} 是條款及細則的 ID。進行更新時,您需要在要求主體中指定更新的設定和條款 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

條款與細則的機構。

不適用

後續步驟

如要瞭解如何在「管理支援的貨幣」中,為貴機構新增最初設定的支援貨幣,請參閱相關說明。