管理條款及細則

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件
資訊

簡介

你必須先在機構資料中新增條款及細則 (下稱「條款及細則」),才能發布費率方案。條款及細則不在機構範圍內 請在機構個人資料中指定您 條款及細則

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

透過 UI 新增條款及細則

  1. 按照探索機構設定檔頁面中所述,存取「機構資料」頁面。
  2. 按一下「編輯」
  3. 在「機構資料」網頁的「條款及細則」區段中,按一下新增條款與 限制條件

    系統隨即顯示「新增條款及細則」對話方塊

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

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

    版本

    條款及細則的版本。版本號碼可讓你 條款及細則的不同版本

    網址

    條款及細則的網址。

  5. 按一下「Create」(建立)

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

  6. 重複步驟 3 到步驟 5,新增更多條款及細則。
  7. 按一下「儲存」,儲存您對機構個人資料的變更內容。

透過 UI 編輯條款及細則

您無法直接編輯條款及細則。而是必須刪除條款及細則 然後新增條款及細則項目

透過使用者介面刪除條款及細則

  1. 按照探索機構設定檔頁面中所述,存取「機構資料」頁面。
  2. 按一下「機構資料」頁面中的「編輯」
  3. 在 T&C 清單中,將遊標移至要刪除的條款及細則上。
  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

向以下機構發出 GET 要求,查看機構所有條款及細則 /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 會設為世界標準時間「目前時間」
{
  "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

條款及細則的機構。

不適用

後續步驟

瞭解如何為貴機構的初始設定新增支援的貨幣 管理受支援的服務