Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Quản lý gói giá bằng giao diện người dùng và API, như mô tả trong những phần sau.
Khám phá trang gói giá
Truy cập vào trang gói giá theo mô tả dưới đây.
Edge
Để xem các gói giá trong giao diện người dùng Edge, hãy truy cập vào trang Rate Plans (Gói giá):
- Đăng nhập vào apigee.com/edge.
- Chọn Xuất bản > Kiếm tiền > Gói giá trong thanh điều hướng bên trái.
Trang Gói giá sẽ xuất hiện.
Như được làm nổi bật trong hình, trang Gói giá cho phép bạn:
- Xem thông tin tóm tắt của tất cả các gói giá, bao gồm cả tên kế hoạch, gói sản phẩm API, trạng thái (đã xuất bản hoặc bản nháp), chi phí kế hoạch cũng như ngày bắt đầu và ngày kết thúc.
LƯU Ý: Các gói giá đã hết hạn sẽ không xuất hiện trong giao diện người dùng. Để xem các gói giá đã hết hạn, hãy sử dụng API. Hãy xem phần Xem gói giá bằng API. - Tạo gói giá
- Chỉnh sửa gói giá
- Phát hành gói giá
- Xoá gói giá nháp
- Thêm gói giá trong tương lai, như mô tả trong bài viết Quản lý gói giá trong tương lai
- Tìm kiếm danh sách gói giá trong một trường hiển thị bất kỳ, tên nhà phát triển hoặc danh mục (nếu có)
Phiên bản cũ (Đám mây riêng tư)
Để xem các gói giá bằng giao diện người dùng Classic Edge, hãy truy cập vào trang Gói API:
- Đăng nhập vào
http://ms-ip:9000
, trong đó ms-ip là địa chỉ IP hoặc tên DNS của nút Máy chủ quản lý. - Chọn Publish > Packages (Xuất bản > Gói) ở thanh điều hướng trên cùng.
Trang API Packages (Gói API) cho thấy các gói giá được xác định cho từng gói.
Trang Gói giá cho phép bạn:
- Tạo gói giá
- Chỉnh sửa gói giá
- Phát hành gói giá
- Xoá gói giá nháp
- Thêm gói giá trong tương lai, như mô tả trong bài viết Quản lý gói giá trong tương lai
- Tìm kiếm danh sách gói giá trong một trường hiển thị bất kỳ, tên nhà phát triển hoặc danh mục (nếu có)
Tạo gói giá
Cách tạo gói giá:
- Truy cập vào trang Gói giá.
- Nhấp vào +Gói giá.
- Định cấu hình các trường sau trong bảng trên cùng:
Trường Nội dung mô tả Mặc định Bắt buộc Tên gói giá Tên gói giá của bạn. LƯU Ý: Tên phải là duy nhất trong gói sản phẩm API. Hai gói trong cùng một gói sản phẩm không thể trùng tên.
Không áp dụng Có Loại gói giá Loại gói giá. Chọn một giá trị trong danh sách thả xuống. Để biết danh sách các loại gói giá hợp lệ, hãy xem bài viết Các loại gói giá được hỗ trợ. Không áp dụng Có Gói sản phẩm Gói sản phẩm API. Chọn một giá trị trong danh sách thả xuống. Để biết thêm thông tin về gói sản phẩm API, hãy xem bài viết Quản lý gói sản phẩm API. Nếu chọn một gói sản phẩm có chứa nhiều sản phẩm API, bạn cần lựa chọn xem nên định cấu hình từng gói giá cho từng sản phẩm API hay định cấu hình một gói giá chung áp dụng cho tất cả sản phẩm API.
Không áp dụng Có Đối tượng người xem Đối tượng có thể truy cập vào gói giá. Chọn một trong các giá trị sau từ danh sách thả xuống: - Mọi người – Tất cả nhà phát triển.
- Nhà phát triển – Nhà phát triển hoặc công ty. Nhập tên nhà phát triển hoặc công ty. Khi bạn nhập, danh sách các nhà phát triển/công ty chứa chuỗi này sẽ hiển thị trong trình đơn thả xuống. Nhấp vào tên của nhà phát triển hoặc công ty trong danh sách thả xuống.
- Danh mục nhà phát triển – Danh mục nhà phát triển. Chọn danh mục nhà phát triển trong danh sách thả xuống.
Định cấu hình danh mục nhà phát triển theo yêu cầu, như mô tả trong Quản lý danh mục nhà phát triển.
Mọi người Không Ngày bắt đầu Ngày gói giá có hiệu lực. Nhập ngày bắt đầu hoặc dùng lịch để chọn ngày. Hôm nay Không Ngày kết thúc Ngày kết thúc gói giá. Để chỉ định ngày kết thúc, hãy bật nút chuyển Có ngày kết thúc rồi nhập ngày kết thúc hoặc chọn một ngày bằng lịch. LƯU Ý: Gói giá sẽ có hiệu lực cho đến cuối ngày vào ngày được chỉ định. Ví dụ: nếu muốn hết hạn một gói giá vào ngày 1 tháng 12 năm 2018, bạn nên đặt giá trị endDate thành 2018-11-30. Trong trường hợp này, gói giá sẽ hết hạn vào cuối ngày 30 tháng 11 năm 2018; tất cả các yêu cầu vào ngày 1 tháng 12 năm 2018 sẽ bị chặn.
Không có Không Hiển thị cho cổng thông tin Hãy đặt gói giá là Công khai hoặc Riêng tư. Xem phần Gói giá công khai và riêng tư. Đang bật Không - Thiết lập mức phí cho gói giá. Xem phần Định cấu hình phí cho gói giá.
LƯU Ý: Không áp dụng cho các kế hoạch thông báo có thể điều chỉnh. - Nếu bạn chọn một gói sản phẩm có chứa nhiều sản phẩm API, hãy thiết lập các lựa chọn ưu tiên sau trong phần Gói giá cụ thể hoặc gói giá chung:
LƯU Ý: Bước này không áp dụng cho các gói thông báo có thể điều chỉnh.
Trường Nội dung mô tả Mặc định Định cấu hình riêng từng sản phẩm Cờ chỉ định xem có thiết lập một gói giá riêng cho từng sản phẩm API hay không. Đã tắt Thiết lập ưu đãi thu phí trong miễn phí của từng sản phẩm Cờ chỉ định xem có định cấu hình gói thu phí trong miễn phí cho từng sản phẩm API hay không. Đã tắt Chọn một sản phẩm Nếu bật một hoặc cả hai cờ, bạn phải chọn riêng từng sản phẩm trong danh sách thả xuống rồi định cấu hình chi tiết gói giá. LƯU Ý: Hãy nhớ định cấu hình tất cả sản phẩm trong gói sản phẩm.
Không áp dụng - Thiết lập chi tiết gói giá dựa trên loại gói giá đã chọn:
- Nhấp vào một trong các mục sau:
Nút Nội dung mô tả Lưu dưới dạng bản nháp Lưu gói giá dưới dạng bản nháp. Nhà phát triển ứng dụng sẽ không nhìn thấy gói giá cho đến khi bạn phát hành gói giá đó. Bạn có thể chỉnh sửa bất kỳ trường nào trong gói giá nháp.
Xuất bản kế hoạch mới Xuất bản kế hoạch. LƯU Ý: Sau khi xuất bản gói giá, bạn chỉ có thể sửa đổi ngày kết thúc nếu chưa đặt ngày kết thúc. Bạn không thể xoá một gói giá sau khi xuất bản, nhưng bạn có thể hết hạn và thay thế gói giá đó bằng một gói giá trong tương lai, như mô tả trong phần Hết hạn gói giá được công bố.
- Đính kèm chính sách Kiểm tra giới hạn về hoạt động kiếm tiền vào các proxy API liên kết với các sản phẩm API có trong gói giá. Chính sách Kiểm tra giới hạn kiếm tiền thực thi các giới hạn kiếm tiền trên các proxy API, đồng thời đảm bảo rằng mọi lỗi đều được thu thập chính xác trong các báo cáo phân tích và báo cáo kiếm tiền. Để biết thêm thông tin, hãy xem phần Áp dụng giới hạn kiếm tiền đối với proxy API.
Chỉnh sửa gói giá
Bạn có thể chỉnh sửa tất cả các trường trong gói giá nháp, ngoại trừ Gói sản phẩm, loại và đối tượng. Sau khi xuất bản gói giá, bạn chỉ có thể chỉnh sửa ngày kết thúc và chỉ có thể chỉnh sửa ngày kết thúc khi chưa chỉ định ngày kết thúc.
Cách chỉnh sửa gói giá:
- Truy cập vào trang Gói giá.
- Nhấp vào trong hàng của gói giá mà bạn muốn chỉnh sửa.
Bảng giá sẽ xuất hiện. - Chỉnh sửa các trường gói giá theo yêu cầu.
LƯU Ý: Sau khi xuất bản gói giá, bạn chỉ có thể sửa đổi ngày kết thúc nếu chưa đặt ngày kết thúc. - Nhấp vào một trong các mục sau:
Nút Nội dung mô tả Bản cập nhật dự thảo (gói giá nháp) Lưu gói giá dưới dạng bản nháp.
Nhà phát triển ứng dụng sẽ không nhìn thấy gói giá cho đến khi bạn phát hành gói giá đó. Bạn có thể chỉnh sửa bất kỳ trường nào trong gói giá nháp.Phát hành dự thảo (gói giá dự thảo) Xuất bản gói giá.
LƯU Ý: Sau khi xuất bản gói giá, bạn chỉ có thể sửa đổi ngày kết thúc nếu chưa đặt ngày kết thúc. Bạn không thể xoá một gói giá sau khi xuất bản, nhưng bạn có thể hết hạn và thay thế gói giá đó bằng một gói giá trong tương lai, như mô tả trong phần Hết hạn gói giá được công bố.Ngày kết thúc cập nhật (gói giá được công bố) Đặt ngày kết thúc cho kế hoạch được xuất bản.
LƯU Ý: Bạn không thể sửa đổi ngày kết thúc cho gói giá đã công bố nữa.
Xoá gói giá nháp
Xoá gói giá nháp nếu không cần nữa.
LƯU Ý: Bạn không thể xoá gói giá đã đăng.
Cách xoá gói giá nháp:
- Truy cập vào trang Gói giá.
- Đặt con trỏ lên gói giá mà bạn muốn xoá để mở trình đơn thao tác.
- Nhấp vào .
- Nhấp vào Xoá để xác nhận thao tác.
Quản lý gói giá bằng API
Các phần sau đây mô tả cách quản lý gói giá bằng API.
Tạo gói giá bằng API
Để tạo gói giá, hãy gửi yêu cầu POST tới /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans
, trong đó {monetizationpackage_id}
là mã nhận dạng của gói sản phẩm API mà bạn tạo gói giá (mã được trả về trong phản hồi khi bạn tạo gói sản phẩm API).
Khi tạo gói giá, bạn phải chỉ định những thông tin sau trong nội dung yêu cầu:
- Mã tổ chức
- Mã gói sản phẩm API
- Tên của gói giá
- Nội dung mô tả về gói giá
- Phạm vi của gói giá (cho dù là áp dụng cho tất cả nhà phát triển hay chỉ cho một nhà phát triển, công ty hoặc danh mục nhà phát triển cụ thể)
- Ngày gói giá có hiệu lực
- Đơn vị tiền tệ của gói giá
- Việc có phát hành gói giá hay không
- Gói giá là công khai hay riêng tư
Ngoài ra còn có các chế độ cài đặt khác mà bạn có thể chỉ định (không bắt buộc), chẳng hạn như khoảng thời gian đến hạn thanh toán (ví dụ: 30 ngày). Xem bài viết Cơ sở lưu trú cấu hình cho gói giá.
Nếu tạo một gói giá (không phải gói chỉ có phí) cho một gói sản phẩm API có nhiều sản phẩm, thì bạn có thể áp dụng gói đó cho một sản phẩm cụ thể trong gói sản phẩm đó. Bạn thực hiện việc này bằng cách xác định sản phẩm trong yêu cầu. Nếu bạn không xác định một sản phẩm thì gói này sẽ áp dụng cho tất cả sản phẩm trong gói sản phẩm API.
Các phần sau đây mô tả cách tạo gói giá:
- Tạo gói giá chuẩn bằng API
- Tạo gói giá cho nhà phát triển hoặc công ty bằng API
- Tạo gói giá cho danh mục nhà phát triển bằng API
- Tạo gói giá dành riêng cho sản phẩm API bằng API
- Đặt gói giá ở chế độ công khai hoặc riêng tư bằng API
Tạo gói giá chuẩn bằng API
Để tạo gói giá chuẩn, hãy đặt thuộc tính type
thành STANDARD
như trong ví dụ sau.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : false, "ratePlanDetails": [ { … } ], "startDate": "2013-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \ -u email:password
Tạo gói giá cho nhà phát triển hoặc công ty bằng API
Để áp dụng gói giá cho một nhà phát triển hoặc công ty cụ thể, hãy đặt giá trị type
thành Developer
. Bạn cũng cần xác định nhà phát triển hoặc công ty trong yêu cầu,
xác định mã nhận dạng, tên pháp lý và tên của nhà phát triển của công ty đó.
Ví dụ: phần trích dẫn sau đây tạo một gói giá cho nhà phát triển Dev Five
:
... "type": "DEVELOPER", "developer" : { "id" : "0mkKu1PALUGfjUph", "legalName" : "DEV FIVE", "name" : "Dev Five" } ...
Tạo gói giá theo danh mục nhà phát triển bằng API
Để áp dụng gói giá cho một danh mục nhà phát triển, hãy đặt giá trị type
thành Developer_Category
. Bạn cũng cần xác định danh mục nhà phát triển trong yêu cầu.
Ví dụ:
... "type": "DEVELOPER_CATEGORY", "developerCategory" : { "id" : "5e172299-8232-45f9-ac46-40076139f373", "name" : "Silver", "description" : "Silver category" } ...
Tạo gói giá dành riêng cho sản phẩm API bằng API
Khi tạo gói giá cho các gói sản phẩm API bao gồm nhiều sản phẩm API, bạn có thể chỉ định chi tiết gói giá cho từng sản phẩm API.
Ví dụ: nội dung sau đây sẽ tạo kế hoạch chia sẻ doanh thu với hai sản phẩm API:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Multi-product rate plan", "currency": { "id" : "usd" }, "description": "Multi-product rate plan", "displayName" : "Multi-product rate plan", "monetizationPackage": { "id": "mypackage", ... }, "organization": { "id": "{org_name}", ... }, "published": true, "isPrivate" : false, "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":0, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product1","displayName":"Product1"}, "customPaymentTerm":false }, { "ratePlanRates":[{ "revshare":10, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product2","displayName":"Product2"}, "customPaymentTerm":false } ], "startDate": "2019-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \ -u email:password
Để thêm một sản phẩm API vào gói sản phẩm API my-package
, bạn cần thêm thông tin chi tiết về gói giá cho sản phẩm API đó trong nội dung yêu cầu, như mô tả trong bài viết Thêm sản phẩm API vào gói sản phẩm API với các gói giá dành riêng cho sản phẩm API.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "ratePlan": [ { "id": "my-package_multi-product-rate-plan", "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":20, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "customPaymentTerm":false }] }] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \ -u email:password
Đặt gói giá ở chế độ công khai hoặc riêng tư bằng API
Khi tạo một gói giá, bạn có thể chỉ định xem gói giá đó là công khai hay riêng tư bằng cách sử dụng thuộc tính isPrivate
trong nội dung yêu cầu. Nếu bạn đặt thành true
, gói giá sẽ ở chế độ riêng tư. Để biết thêm thông tin, hãy xem bài viết Gói giá công khai và riêng tư.
Ví dụ: nội dung sau đây sẽ tạo một gói giá ưu đãi chọn lọc:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : true, "ratePlanDetails": [ { … } ], "startDate": "2013-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \ -u email:password
Phát hành gói giá bằng API
Để phát hành một gói giá, hãy đặt giá trị thuộc tính published
thành true khi bạn tạo gói giá. Nhà phát triển sẽ có thể xem gói giá bắt đầu từ ngày được chỉ định trong
tài sản startDate
của gói đó.
Ví dụ: nội dung sau đây sẽ tạo một kế hoạch bảng giá và xuất bản kế hoạch đó (chỉ một phần của yêu cầu được hiển thị):
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Flat rate card plan", "developer":null, "developerCategory":null, "advance": "false", … "published": "true", "ratePlanDetails": [ … ], … "type": "RATECARD" }], … }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \ -u email:password
Lưu bản nháp gói giá bằng API
Để lưu một gói giá mà không phát hành, hãy đặt giá trị thuộc tính published
thành false khi bạn tạo gói giá.
Ví dụ: nội dung sau đây sẽ tạo một gói giá và lưu dưới dạng bản nháp (chỉ một phần của yêu cầu được hiển thị):
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Flat rate card plan", "developer":null, "developerCategory":null, "advance": "false", … "published": "false", "ratePlanDetails": [ … ], … "type": "RATECARD" }], … }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \ -u email:password
Chỉnh sửa bản nháp gói giá bằng API
Để cập nhật một bản nháp gói giá, hãy gửi yêu cầu PUT cho /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}
, trong đó {package_id}
là thông tin nhận dạng gói API và {plan_Id}
là thông tin nhận dạng gói giá. Khi 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à mã gói giá. Nếu cập nhật một mức giá của gói giá, bạn cũng cần chỉ định mã của mức giá của gói giá. Ví dụ: yêu cầu sau đây cập nhật mức giá cho gói giá trong một gói giá có mã là location_flat_rate_card_plan
(thông tin cập nhật này sẽ được làm nổi bật):
$ curl -H "Content-Type: application/json" -X PUT -d \ '{ "id" : "location_flat_rate_card_plan", "name": "Flat rate card plan", "advance": "false", "currency": { "id" : "usd" }, "description": "Flat rate card plan", "displayName" : "Flat rate card plan", "frequencyDuration": "30", "frequencyDurationType": "DAY", "earlyTerminationFee": "10", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "paymentDueDays": "30", "prorate": "false", "published": "false", "ratePlanDetails": [ { "currency": { "id" : "usd" }, "paymentDueDays": "30", "meteringType": "UNIT", "organization": { "id": "{org_name}" }, "ratePlanRates": [ { "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec", "type": "RATECARD", "rate": "0.15", "startUnit": "0" } ], "ratingParameter": "VOLUME", "type": "RATECARD" }], "recurringStartUnit": 1, "recurringType": "CALENDAR", "recurringFee": "10", "setUpFee": "10", "startDate": "2013-09-15 00:00:00", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \ -u email:password
Nội dung phản hồi có chứa mức giá của gói giá mới cập nhật (chỉ một phần nội dung phản hồi xuất hiện):
… "ratePlanRates" : [ { "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec", "rate" : 0.15, "startUnit" : 0, "type" : "RATECARD" } ], …
Xem các gói giá bằng API
Bạn có thể xem các gói giá bằng API kiếm tiền như mô tả ở các phần sau.
- Xem tất cả các gói giá cho tổ chức bằng API
- Xem tất cả các gói giá cho gói sản phẩm API bằng API
- Xem gói giá cho gói sản phẩm API bằng API
- Xem tất cả các gói giá đang hoạt động của nhà phát triển bằng API
- Xem gói giá được chấp nhận cho nhà phát triển bằng API
- Xem gói giá được chấp nhận cho nhà phát triển chứa sản phẩm API bằng API
- Xem tất cả các gói giá được nhà phát triển chấp nhận bằng API này
Xem tất cả các gói giá cho một tổ chức bằng API
Để xem tất cả các gói giá cho một tổ chức, hãy gửi yêu cầu GET đến /mint/organizations/{org_name}/rate-plans
, trong đó {org_name}
là tên của tổ chức.
Bạn có thể chuyển các tham số truy vấn sau đây để lọc kết quả:
Tham số truy vấn | Nội dung mô tả |
---|---|
all |
Cờ chỉ định việc có trả về tất cả các gói giá hay không. Nếu bạn đặt thành false , thì số gói giá được trả về trên mỗi trang sẽ được xác định bằng tham số truy vấn size . Mặc định là true . |
size |
Số gói API được trả về trên mỗi trang. Nếu bạn đặt tham số truy vấn all thành true , thì tham số này sẽ bị bỏ qua. |
page |
Số trang mà bạn muốn trả về (nếu nội dung được phân trang). Nếu bạn đặt tham số truy vấn all thành true , thì tham số này sẽ bị bỏ qua. |
Ví dụ:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \ -u email:password
Xem tất cả các gói giá cho gói sản phẩm API bằng API
Để xem tất cả các gói giá cho một gói API, hãy gửi yêu cầu GET tới /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
, trong đó {package_id}
là mã nhận dạng của gói API (mã gói sẽ được trả về khi bạn tạo gói kiếm tiền).
Theo mặc định, chỉ những gói giá đang hoạt động, công khai và chuẩn mới được trả về trong kết quả. Để bao gồm:
- Gói giá nháp hoặc đã hết hạn, hãy đặt tham số truy vấn
current
thànhfalse
(ví dụ:?current=false
). - Gói giá ưu đãi chọn lọc, hãy đặt tham số truy vấn
showPrivate
thànhtrue
(ví dụ:?showPrivate=true
). - Đối với tất cả các gói giá tiêu chuẩn, hãy đặt tham số truy vấn
standard
thànhtrue
(ví dụ:?standard=true
).
Ví dụ:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \ -u email:password
Xem gói giá cho gói API bằng API
Để xem gói giá cho một gói API, hãy gửi yêu cầu GET đến /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}
, trong đó {package_id}
là mã của gói API và {plan_id}
là mã của gói giá (mã gói được trả về khi bạn tạo gói kiếm tiền và mã gói giá được trả về khi bạn tạo gói giá).
Ví dụ:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \ -u email:password
Sau đây là ví dụ về phản hồi:
{ "advance" : true, "contractDuration" : 1, "contractDurationType" : "YEAR", "currency" : { "id" : "usd", ... "organization" : { ... }, ... }, "description" : "Standard Fixed Plan", "displayName" : "Standard Fixed Plan", "earlyTerminationFee" : 0.0000, "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "id" : "communications_standard_fixed_plan", "isPrivate" : false, "monetizationPackage" : { "description" : "Communications", "displayName" : "Communications", "id" : "communications", "name" : "Communications", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Standard Fixed Plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : true, "published" : true, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86", "meteringType" : "UNIT", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2", "rate" : 0.0500, "startUnit" : 0, "type" : "RATECARD" } ], "ratingParameter" : "VOLUME", "type" : "RATECARD" } ], "recurringFee" : 200.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 100.0000, "startDate" : "2013-01-11 22:00:00", "type" : "STANDARD" }
Xem tất cả các gói giá đang hoạt động của nhà phát triển bằng API
Để xem tất cả các gói giá đang có hiệu lực của nhà phát triển, hãy gửi yêu cầu GET tới /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans
, trong đó {developer_id}
là địa chỉ email của nhà phát triển.
Bạn có thể chuyển các tham số truy vấn sau đây để lọc kết quả:
Tham số truy vấn | Nội dung mô tả |
---|---|
all |
Cờ chỉ định xem có trả về tất cả các gói API hay không. Nếu bạn đặt thành false , thì số lượng gói API được trả về trên mỗi trang sẽ được xác định bằng tham số truy vấn size . Mặc định là false . |
size |
Số gói API được trả về trên mỗi trang. Giá trị mặc định là 20. Nếu bạn đặt tham số truy vấn all thành true , thì tham số này sẽ bị bỏ qua. |
page |
Số trang mà bạn muốn trả về (nếu nội dung được phân trang). Nếu bạn đặt tham số truy vấn all thành true , thì tham số này sẽ bị bỏ qua. |
Ví dụ:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \ -u email:password
Sau đây là ví dụ về phản hồi:
{ "ratePlan" : [ { "advance" : true, "contractDuration" : 1, "contractDurationType" : "MONTH", "currency" : { "description" : "United States Dollar", "displayName" : "United States Dollar", "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "description" : "Fee Only RatePlan", "displayName" : "Fee Only RatePlan", "earlyTerminationFee" : 10.0000, "freemiumDuration" : 0, "freemiumDurationType" : "MONTH", "freemiumUnit" : 0, "frequencyDuration" : 1, "frequencyDurationType" : "WEEK", "id" : "messaging_package_fee_only_rateplan", "isPrivate" : false, "monetizationPackage" : { "description" : "messaging package", "displayName" : "Messaging Package", "id" : "messaging_package", "name" : "Messaging Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "customAtt2Name" : "response size", "customAtt3Name" : "content-length", "description" : "messaging api product", "displayName" : "messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "status == 'SUCCESS'" } ], "status" : "CREATED" }, "name" : "Fee Only RatePlan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : true, "ratePlanDetails" : [ ], "recurringFee" : 10.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 20.0000, "startDate" : "2013-02-20 00:00:00", "type" : "STANDARD" } ], "totalRecords" : 1 }
Xem gói giá được chấp nhận cho nhà phát triển bằng API
Để xem một gói giá đang có hiệu lực cho nhà phát triển, hãy gửi yêu cầu GET tới /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}
, trong đó {developer_id}
là địa chỉ email của nhà phát triển và {developer_rateplan_id}
là mã của gói giá được chấp nhận và được trả về trong phản hồi khi bạn chấp nhận gói giá đã công bố.
Ví dụ:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \ -u email:password
Sau đây là ví dụ về phản hồi:
{ "created" : "2018-01-25 20:01:54", "developer" : { }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }
Xem gói giá được chấp nhận của nhà phát triển có chứa sản phẩm API bằng API
Để xem gói giá được chấp nhận cho một nhà phát triển có chứa sản phẩm API, hãy gửi yêu cầu GET tới /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product
, trong đó {developer_id}
là mã nhận dạng của nhà phát triển và /{product_id}
là mã nhận dạng của sản phẩm.
Theo mặc định, chỉ một gói giá công khai mới được trả về trong kết quả. Để hiển thị gói giá ưu đãi chọn lọc, hãy đặt tham số truy vấn showPrivate
thành true
(ví dụ: ?showPrivate=true
).
Ví dụ:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \ -u email:password
Xem tất cả các gói giá được nhà phát triển chấp nhận bằng API
Để xem các gói giá mà nhà phát triển đã chấp nhận, hãy gửi yêu cầu GET tới /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans
, trong đó {developer_id}
là mã nhận dạng của nhà phát triển.
Bạn có thể chuyển các tham số truy vấn sau đây để lọc kết quả:
Tham số truy vấn | Nội dung mô tả |
---|---|
all |
Cờ chỉ định xem có trả về tất cả các gói API hay không. Nếu bạn đặt thành false , thì số lượng gói API được trả về trên mỗi trang sẽ được xác định bằng tham số truy vấn size . Mặc định là false . |
size |
Số gói API được trả về trên mỗi trang. Giá trị mặc định là 20. Nếu bạn đặt tham số truy vấn all thành true , thì tham số này sẽ bị bỏ qua. |
page |
Số trang mà bạn muốn trả về (nếu nội dung được phân trang). Nếu bạn đặt tham số truy vấn all thành true , thì tham số này sẽ bị bỏ qua. |
Ví dụ:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \ -u email:password
Sau đây là ví dụ về phản hồi:
{ "developerRatePlan" : [ { "created" : "2018-01-25 20:01:54", "developer" : { ... }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }], "totalRecords" : 1 }
Xoá bản nháp gói giá bằng API
Để xoá một bản nháp gói giá, hãy gửi yêu cầu DELETE cho /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}
, trong đó {plan_Id}
là giá trị nhận dạng gói giá cần xoá và {package_id}
là thông tin nhận dạng gói API của gói giá. Ví dụ:
$ curl -H "Accept:application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \ -u email:password
Thuộc tính cấu hình cho gói giá
Khi tạo gói giá bằng API, bạn có thể chỉ định các chế độ cài đặt cấu hình sau.
Tên | Nội dung mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
advance |
Chỉ áp dụng đối với các khoản phí định kỳ. Cờ chỉ định liệu có tính phí định kỳ trước hay không. Các giá trị hợp lệ bao gồm:
|
false | Không |
contractDuration |
Thời hạn của hợp đồng cho gói cùng với |
Không áp dụng | Không |
contractDurationType |
Thời hạn của hợp đồng cho gói cùng với
|
Không áp dụng | Không |
currency |
Đơn vị tiền tệ được sử dụng cho gói giá. Hãy chỉ định mã ISO 4217 cho đơn vị tiền tệ, chẳng hạn như |
Không áp dụng | Có |
description |
Nội dung mô tả về gói giá. |
Không áp dụng | Có |
developer |
Mã nhà phát triển (địa chỉ email). Chỉ chỉ định cho các gói giá dành cho nhà phát triển. |
Không áp dụng | Không |
developerCategory |
Mã danh mục nhà phát triển. Chỉ chỉ định cho gói giá thuộc danh mục nhà phát triển. |
Không áp dụng | Không |
displayName |
Tên hiển thị thân thiện với người dùng cho gói giá. |
Không áp dụng | Có |
earlyTerminationFee |
Phí một lần sẽ được tính nếu nhà phát triển kết thúc gói trước thời hạn gia hạn. |
Không áp dụng | Không |
endDate |
Ngày kết thúc kế hoạch. Sau ngày này, nhà phát triển sẽ không xem được gói giá. Nếu bạn không muốn gói giá kết thúc vào một ngày cụ thể, hãy chỉ định một giá trị rỗng cho Gói giá sẽ có hiệu lực cho đến cuối ngày vào ngày được chỉ định. Ví dụ: nếu muốn hết hạn một gói giá vào ngày 1 tháng 12 năm 2016, bạn nên đặt giá trị endDate thành 2016-11-30. Trong trường hợp này, gói giá sẽ hết hạn vào cuối ngày, tức là ngày 30 tháng 11 năm 2016; tất cả các yêu cầu vào ngày 1 tháng 12 năm 2016 sẽ bị chặn. LƯU Ý: Khi bạn xem gói giá bằng API, dấu thời gian endDate được chỉ định là |
Không áp dụng | Không |
freemiumDuration |
Khoảng thời gian cho thời gian thu phí trong miễn phí cùng với |
Không áp dụng | Không |
freemiumDurationType |
Khoảng thời gian cho thời gian thu phí trong miễn phí cùng với
|
Không áp dụng | Không |
freemiumUnit |
Số lượng thu phí trong miễn phí. Giá trị này có thể là số lượng giao dịch hoặc số lượng đơn vị liên quan đến một thuộc tính tuỳ chỉnh được ghi lại trong chính sách ghi lại giao dịch. |
Không áp dụng | Không |
frequencyDuration |
Chỉ áp dụng đối với các khoản phí định kỳ. Khoảng thời gian giữa các lần tính phí định kỳ cho đến ngày |
Không áp dụng | Không |
frequencyDurationType |
Chỉ áp dụng đối với các khoản phí định kỳ. Khoảng thời gian giữa các lần tính phí định kỳ cho đến ngày frequencyDuration . Sau đây là các giá trị hợp lệ:
|
Không áp dụng | Không |
isPrivate |
Cờ chỉ định liệu gói giá là công khai hay riêng tư. Giá trị mặc định là false (công khai). Để biết thêm thông tin, hãy xem bài viết Gói giá công khai và riêng tư. |
Không áp dụng | Không |
monetizationPackage |
Mã gói sản phẩm API cho gói giá. |
Không áp dụng | Không |
name |
Tên của gói giá. |
Không áp dụng | Có |
organization |
Mã tổ chức của gói giá. |
Không áp dụng | Có |
paymentDueDays |
Chỉ áp dụng đối với các khoản phí định kỳ. Số ngày đến hạn thanh toán khoản phí. Ví dụ: đặt giá trị thành 30 để cho biết các khoản phí đến hạn sau 30 ngày. |
Không áp dụng | Không |
proRate |
Chỉ áp dụng đối với các khoản phí định kỳ. Cờ cho biết liệu phí định kỳ có được chia theo tỷ lệ hay không khi nhà phát triển bắt đầu hoặc kết thúc một phần của kế hoạch trong một tháng. Các giá trị hợp lệ bao gồm:
|
false | Không |
published |
Cờ chỉ định xem có nên phát hành gói giá để nhà phát triển xem hay không. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Có |
ratePlanDetails |
Thông tin chi tiết về gói giá (xem phần Các cơ sở lưu trú cấu hình để biết thông tin chi tiết về gói giá). |
Không áp dụng | Có |
recurringFee |
Phí được tính cho nhà phát triển liên tục cho đến khi nhà phát triển chấm dứt gói. |
Không áp dụng | Không |
recurringStartUnit |
Chỉ hợp lệ nếu bạn đặt |
Không áp dụng | Không |
recurringType |
Lịch phí định kỳ. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
setUpFee |
Phí một lần được tính cho mỗi nhà phát triển vào ngày bắt đầu sử dụng gói (tức là ngày nhà phát triển mua gói). |
Không áp dụng | Không |
startDate |
Ngày bắt đầu kế hoạch. Nhà phát triển có thể xem gói giá kể từ ngày này. |
Không áp dụng | Có |
type |
Loại gói giá. Hãy chỉ định một trong các mục sau:
|
Không áp dụng | Có |
Các thuộc tính cấu hình cho thông tin về gói giá
Bạn có thể chỉ định bất kỳ phiên bản cấu hình nào sau đây trong mảng ratePlanDetails
khi tạo gói giá.
Tên | Nội dung mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
aggregateFreemiumCounters |
Cờ chỉ định xem có bật bộ đếm tổng hợp hay không để xác định xem mức sử dụng của một sản phẩm API có nằm trong phạm vi trống hay không. Bạn phải bật bộ đếm tổng hợp để thiết lập gói thu phí trong miễn phí cho một sản phẩm. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
aggregateStandardCounters |
Cờ chỉ định xem có dùng bộ đếm tổng hợp hay không để xác định băng tần sử dụng (chẳng hạn như băng tần âm lượng cho gói giá). Giá trị này có thể là một trong những giá trị sau:
|
Không áp dụng | Không |
aggregateTransactions |
LƯU Ý: Tài sản này hiện không được dùng cho tính năng kiếm tiền và có thể bỏ qua. |
đúng | Không |
currency |
Tiền tệ. |
Không áp dụng | Không |
duration |
Khoảng thời gian cho tần suất tính toán, cùng với Ví dụ: đặt |
Không áp dụng | Không |
durationType |
Khoảng thời gian cho tần suất tính toán, cùng với Hãy xem |
Không áp dụng | Không |
freemiumDuration |
Khoảng thời gian trong thời gian thu phí trong miễn phí cho một sản phẩm API riêng lẻ cùng với |
Không áp dụng | Không |
freemiumDurationType |
Khoảng thời gian trong thời gian thu phí trong miễn phí cho một sản phẩm API riêng lẻ cùng với
Ví dụ: để chỉ định thời gian thu phí trong miễn phí cho một sản phẩm API là 30 ngày, hãy đặt |
Không áp dụng | Không |
freemiumUnit |
Số lượng thu phí trong miễn phí cho một sản phẩm API. Giá trị này có thể là số lượng giao dịch hoặc số lượng đơn vị liên quan đến một thuộc tính tuỳ chỉnh được ghi lại trong chính sách ghi lại giao dịch. |
Không áp dụng | Không |
meteringType |
Mô hình tính phí cho gói bảng giá. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | đồng ý |
organization |
Mã tổ chức. |
Không áp dụng | Không |
paymentDueDays |
Ngày đến hạn thanh toán cho nhà phát triển trả sau. Ví dụ: đặt giá trị thành 30 để cho biết rằng khoản thanh toán sẽ đến hạn sau 30 ngày. |
Không áp dụng | Không |
product |
Thông tin sản phẩm API, chẳng hạn như mã nhận dạng. |
Không áp dụng | Không |
ratePlanRates |
Chi tiết về mức giá của gói giá, chẳng hạn như loại gói giá ( |
Không áp dụng | Có |
ratingParameter |
Cơ sở cho gói giá. Gói giá dựa trên số giao dịch hoặc thuộc tính tuỳ chỉnh. Các giá trị hợp lệ bao gồm:
|
VOLUME |
Có |
ratingParameterUnit |
Đơn vị áp dụng cho |
Không áp dụng | Có |
revenueType |
Cơ sở chia sẻ doanh thu trong kế hoạch chia sẻ doanh thu. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
type |
Loại gói giá. Các giá trị hợp lệ bao gồm:
Để biết thêm thông tin về các loại gói giá, hãy xem bài viết Các loại gói giá được hỗ trợ. |
Không áp dụng | Có |