Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Giới thiệu
Bạn phải thêm các điều khoản và điều kiện ("T&C") vào hồ sơ của tổ chức trước khi xuất bản gói giá. T&C nằm bên ngoài hồ sơ của tổ chức. Trong hồ sơ tổ chức của mình, bạn cần chỉ định vị trí (URL công khai) của các Điều khoản và Điều kiện.
Sau khi bạn phát hành một gói giá, phiên bản hiện tại của các Điều khoản và điều kiện sẽ xuất hiện trong cổng thông tin cho nhà phát triển. Nhà phát triển chỉ có thể mua một gói sau khi đã chấp nhận các Đ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ơ của tổ chức, như mô tả trong Khám phá trang Hồ sơ của tổ chức.
- Nhấp vào Chỉnh sửa.
- Trong phần Điều khoản và điều kiện trên 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 Nội dung mô tả Ngày hiệu lực Ngày mà các điều khoản và điều kiện có hiệu lực. 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 một 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.
Các Đ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 trên 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 và điều kiện khác.
- Nhấp vào Lưu để lưu các thay đổi đối với hồ sơ tổ chức.
Chỉnh sửa đ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 các Điều khoản và điều kiện. Thay vào đó, bạn phải xoá các điều khoản và điều kiện mà bạn muốn chỉnh sửa, sau đó thêm một mục điều khoản và điều kiện mới.
Xóa điều khoản và điều kiện bằng cách sử dụng giao diện người dùng
- Truy cập vào trang Hồ sơ của tổ chức, như mô tả trong Khám phá trang Hồ sơ của tổ chức.
- Nhấp vào Chỉnh sửa trên trang Hồ sơ của tổ chức.
- Trong danh sách Điều khoản và Điều kiện, hãy đặt con trỏ lên Điều khoản và Điều kiện bạn muốn xoá.
- Nhấp vào .
Quản lý các điều khoản và điều kiện bằng API
Quản lý các đ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 các Điều khoản và Điều kiện bằng cách gửi yêu cầu POST tới /mint/organizations/{org_name}/tncs
.
Khi thêm các Điều khoản và Điều kiện, bạn có thể tuỳ ý chỉ định:
- URL
- Văn bản đi kèm (chẳng hạn như nội dung mô tả)
- Ngày có hiệu lực của các Điều khoản và điều kiện
- Số phiên bản
Xem phần Thuộc tính cấu hình các đ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 các đ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ả các điều khoản và điều kiện của một tổ chức.
Xem các T&C cụ thể bằng cách gửi yêu cầu GET tới /mint/organizations/{org_name}/tncs/{tncs_id}
, trong đó {tncs_id}
là thông tin nhận dạng các T&C cụ thể (mã nhận dạng được trả về trong phản hồi khi bạn tạo các T&C). 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ả cá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 tới
/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 tài liệu đ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 tài liệu T&C cho nhà phát triển hoặc công ty cụ thể bằng cách gửi yêu cầu POST tới một trong các API sau:
/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à phát triển (địa chỉ email), {company_id}
là mã công ty và {tncs_id}
là mã 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 chấp nhận bằng API
Xem các Điều khoản và điều kiện được 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 tới 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à phát triển (địa chỉ email) và {company_id}
là mã 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 các T&C bằng cách gửi yêu cầu PUT tới /mint/organizations/{org_named}/tncs/{tncs_id}
, trong đó {tncs_id}
là giá trị nhận dạng các T&C. Khi thực hiện 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 cũng như cách nhận dạng các Đ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 của các điều khoản và điều kiện (trong ví dụ này, tài sản đã cập nhật được làm nổi bật):
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á các T&C bằng cách đưa ra yêu cầu DELETE cho /mint/organizations/{org_name}/tncs/{tncs_id}
, trong đó {tncs_id}
là giá trị nhận dạng của T&C. 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
Các 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 có thể được đặt bằng API cho các điều khoản và điều kiện.
Tên | Nội dung mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
url |
URL của các đ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) về các điều khoản và điều kiện. |
Không áp dụng | Không |
version |
Phiên bản của các Điều khoản và Điều kiện. Số phiên bản cho phép bạn theo dõi các phiên bản khác nhau của các Điều khoản và Điều kiện. |
Không áp dụng | Có |
startDate |
Ngày các Điều khoản và Điều kiện có hiệu lực. |
Không áp dụng | Có |
organization |
Sắp xếp các đ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 đơ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ý đơn vị tiền tệ được hỗ trợ.