您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
簡介
發布費率方案前,請務必先在機構設定檔中新增條款及細則 (簡稱「條款」)。服務條款位於機構設定檔外部。在機構設定檔中,指定條款及細則的位置 (公開網址)。
發布費率方案後,開發人員入口網站會顯示目前版本的條款及細則。開發人員必須先接受現行《條款及細則》,才能購買方案。
透過使用者介面新增條款及細則
- 如要存取「機構設定檔」頁面,請參閱「探索機構設定檔頁面」。
- 按一下「編輯」。
- 在機構設定檔頁面的「條款及細則」部分,按一下「新增條款及細則」。
系統會顯示「新條款及細則」對話方塊
- 輸入下列資訊:
欄位 說明 生效日期 條款及細則生效日期。預設為目前日期。你必須輸入目前或未來的日期。
版本 條款及細則版本。版本號碼可讓您追蹤不同版本的條款及細則。
網址 條款及細則的網址。
- 按一下「建立」。
新的條款及細則會新增至機構設定檔頁面的「條款及細則」部分。
- 如要新增其他條款及細則,請重複步驟 3 到 5。
- 按一下「儲存」,儲存機構設定檔變更。
使用使用者介面編輯條款及細則
你無法直接編輯條款及細則,如要編輯條款及細則,請刪除要編輯的條款及細則,然後新增條款及細則項目。
使用 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 (建立條款及細則時,系統會在回應中傳回 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。更新時,您需要在要求主體中指定更新後的設定,以及服務條款的識別資訊。舉例來說,下列要求會編輯條款及細則的版本號碼 (範例中已醒目顯示更新的屬性):
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} 是條款的 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 |
條款及細則的網址。 |
N/A | 否 |
tncText |
條款及細則的文字 (例如簡短說明)。 |
N/A | 否 |
version |
條款及細則版本。版本號碼可協助您追蹤不同版本的條款。 |
N/A | 是 |
startDate |
條款及細則生效日期。 |
N/A | 是 |
organization |
條款及細則的組織。 |
N/A | 否 |
後續步驟
如要瞭解如何為貴機構新增支援的貨幣 (最初設定的貨幣除外),請參閱「管理支援的貨幣」。