Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu Apigee X. thông tin
Giới thiệu
Bạn phải thêm điều khoản và điều kiện ("T&C") vào hồ sơ tổ chức trước khi xuất bản một gói giá. Điều khoản và điều kiện nằm bên ngoài hồ sơ tổ chức. Trong hồ sơ tổ chức, bạn chỉ định vị trí (URL công khai) của Điều khoản và điều kiện.
Sau khi bạn xuất bản một gói giá, phiên bản hiện tại của Điều khoản và điều kiện sẽ xuất hiện trong cổng thông tin dành cho nhà phát triển. Nhà phát triển chỉ có thể mua gói sau khi chấp nhận Điều khoản và điều kiện hiện tại.
Thêm điều khoản và điều kiện bằng giao diện người dùng
- Truy cập vào trang Hồ sơ tổ chức, như mô tả trong phần Khám phá trang Hồ sơ tổ chức.
- Nhấp vào Chỉnh sửa.
- Trong phần Điều khoản và điều kiện của trang Hồ sơ tổ chức, hãy nhấp vào Thêm điều khoản và điều kiện.
Hộp thoại Điều khoản và điều kiện mới sẽ xuất hiện
- Nhập thông tin dưới đây:
Trường Mô tả Ngày có hiệu lực Ngày có hiệu lực của điều khoản và điều kiện. Giá trị mặc định là ngày hiện tại. Bạn phải nhập ngày hiện tại hoặc ngày trong tương lai.
Phiên bản Phiên bản của điều khoản và điều kiện. Số phiên bản giúp bạn theo dõi các phiên bản khác nhau của điều khoản và điều kiện.
URL URL của điều khoản và điều kiện.
- Nhấp vào Tạo.
Điều khoản và điều kiện mới được thêm vào phần Điều khoản và điều kiện của trang Hồ sơ tổ chức.
- Lặp lại các bước từ 3 đến 5 để thêm các điều khoản bổ sung.
- Nhấp vào Lưu để lưu các thay đổi đối với hồ sơ tổ chức.
Chỉnh sửa các điều khoản và điều kiện bằng giao diện người dùng
Bạn không thể chỉnh sửa trực tiếp Điều khoản và điều kiện. Thay vào đó, bạn phải xoá điều khoản và điều kiện mà bạn muốn chỉnh sửa, rồi thêm một mục điều khoản và điều kiện mới.
Xoá điều khoản và điều kiện bằng giao diện người dùng
- Truy cập vào trang Hồ sơ tổ chức, như mô tả trong phần Khám phá trang Hồ sơ tổ chức.
- Nhấp vào Chỉnh sửa trên trang Hồ sơ tổ chức.
- Trong danh sách Điều khoản và điều kiện, hãy di chuyển con trỏ lên Điều khoản và điều kiện mà bạn muốn xoá.
- Nhấp vào
.
Quản lý điều khoản và điều kiện bằng API
Quản lý điều khoản và điều kiện bằng API, như mô tả trong các phần sau.
Thêm điều khoản và điều kiện bằng API
Thêm Điều khoản và điều kiện bằng cách gửi yêu cầu POST đến /mint/organizations/{org_name}/tncs.
Khi thêm Điều khoản và điều kiện, bạn có thể chỉ định (không bắt buộc):
- URL
- Văn bản đi kèm (chẳng hạn như nội dung mô tả)
- Ngày mà Điều khoản và điều kiện có hiệu lực
- Số phiên bản
Hãy xem phần Các thuộc tính cấu hình điều khoản và điều kiện để biết thêm thông tin về các lựa chọn này.
Ví dụ:
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
Sau đây là ví dụ về phản hồi:
{
"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"
}Xem điều khoản và điều kiện bằng API
Xem các điều khoản và điều kiện cụ thể hoặc tất cả điều khoản và điều kiện của một tổ chức.
Xem các điều khoản và điều kiện cụ thể bằng cách gửi yêu cầu GET đến /mint/organizations/{org_name}/tncs/{tncs_id}, trong đó {tncs_id} là thông tin nhận dạng của các điều khoản và điều kiện cụ thể (mã nhận dạng được trả về trong phản hồi khi bạn tạo các điều khoản và điều kiện). Ví dụ:
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
Xem tất cả Điều khoản và điều kiện của tổ chức bằng cách gửi yêu cầu GET đến /mint/organizations/{org_name}/tncs. Ví dụ:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-H "Accept: application/json" \
-u email:password
Sau đây là ví dụ về phản hồi:
{
"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
}Chấp nhận một tài liệu về điều khoản và điều kiện cho nhà phát triển hoặc công ty sử dụng API
Chấp nhận một tài liệu về Điều khoản và điều kiện cho một nhà phát triển hoặc công ty cụ thể bằng cách gửi yêu cầu POST đến một trong các API sau đây, tương ứng:
/mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs
Trong đó {dev_id} là mã nhận dạng nhà phát triển (địa chỉ email), {company_id} là mã nhận dạng công ty và {tncs_id} là mã nhận dạng tài liệu về điều khoản và điều kiện.
Ví dụ:
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
Sau đây là ví dụ về phản hồi:
auditDate được đặt thành thời gian hiện tại theo giờ UTC.{ "action": "ACCEPTED", "auditDate": "2018-10-01 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316", ... } }
Xem các điều khoản và điều kiện mà nhà phát triển hoặc công ty sử dụng API đã chấp nhận
Xem Điều khoản và điều kiện mà một nhà phát triển hoặc công ty cụ thể đã chấp nhận bằng cách gửi yêu cầu GET đến một trong các API sau đây, tương ứng:
/mint/organizations/{org_name}/developers/{dev_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/developer-tncs
Trong đó, {dev_id} là mã nhận dạng nhà phát triển (địa chỉ email) và {company_id} là mã nhận dạng công ty.
Ví dụ:
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
Sau đây là ví dụ về phản hồi:
{ "developerTnc": [ { "action": "ACCEPTED", "auditDate": "2018-08-29 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "26abc14c-c628-4c38-8840-a343c8ee9437", ... } }], "totalRecords": 1 }
Chỉnh sửa điều khoản và điều kiện bằng API
Chỉnh sửa Điều khoản và điều kiện bằng cách đưa ra yêu cầu PUT đến /mint/organizations/{org_named}/tncs/{tncs_id}, trong đó {tncs_id} là thông tin nhận dạng của Điều khoản và điều kiện. Khi thực hiện việc cập nhật, bạn cần chỉ định trong nội dung yêu cầu các chế độ cài đặt đã cập nhật và thông tin nhận dạng của Điều khoản và điều kiện. Ví dụ: yêu cầu sau đây chỉnh sửa số phiên bản cho Điều khoản và điều kiện (thuộc tính được cập nhật sẽ được làm nổi bật trong ví dụ):
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
Sau đây là ví dụ về phản hồi:
{ "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" }
Xoá điều khoản và điều kiện bằng API
Xoá Điều khoản và điều kiện bằng cách gửi yêu cầu XÓA đến /mint/organizations/{org_name}/tncs/{tncs_id}, trong đó {tncs_id} là thông tin nhận dạng của Điều khoản và điều kiện. Ví dụ:
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
Thuộc tính cấu hình điều khoản và điều kiện cho API
Bảng sau đây tóm tắt các thuộc tính cấu hình mà bạn có thể thiết lập bằng API cho điều khoản và điều kiện.
| Tên | Mô tả | Mặc định | Bắt buộc? |
|---|---|---|---|
url |
URL của Điều khoản và điều kiện. |
Không áp dụng | Không |
tncText |
Văn bản (chẳng hạn như nội dung mô tả ngắn) cho Điều khoản và điều kiện. |
Không áp dụng | Không |
version |
Phiên bản của Điều khoản và điều kiện. Số phiên bản giúp bạn theo dõi các phiên bản khác nhau của Điều khoản và điều kiện. |
Không áp dụng | Có |
startDate |
Ngày mà Điều khoản và điều kiện có hiệu lực. |
Không áp dụng | Có |
organization |
Tổ chức đưa ra Điều khoản và điều kiện. |
Không áp dụng | Không |
Các bước tiếp theo
Tìm hiểu cách thêm các đơn vị tiền tệ được hỗ trợ vào những đơn vị tiền tệ được thiết lập ban đầu cho tổ chức của bạn trong phần Quản lý các đơn vị tiền tệ được hỗ trợ.