Định cấu hình kế hoạch thông báo có thể điều chỉnh

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

Trong một kế hoạch thông báo có thể điều chỉnh, nhà cung cấp API có thể điều chỉnh số lượng giao dịch mục tiêu cho từng nhà phát triển ứng dụng. Bạn có thể định cấu hình liệu có gửi thông báo hay không và khi nào hệ thống gửi thông báo dựa trên thời điểm đạt đến một tỷ lệ phần trăm của số mục tiêu, chẳng hạn như 90%, 100% hoặc 150%. Các giao dịch bổ sung sẽ không bị chặn sau khi đạt đến con số mục tiêu.

Định cấu hình kế hoạch thông báo có thể điều chỉnh bằng giao diện người dùng

Định cấu hình kế hoạch thông báo có thể điều chỉnh như mô tả bên dưới.

Edge

Để định cấu hình kế hoạch thông báo có thể điều chỉnh bằng giao diện người dùng Edge, khi thêm hoặc chỉnh sửa kế hoạch giá, hãy chọn loại kế hoạch giá Adjustable Notification (Thông báo có thể điều chỉnh) và trong phần Adjustable Notification (Thông báo có thể điều chỉnh), hãy định cấu hình các thông tin sau:

Trường Nội dung mô tả Mặc định
Tần suất tính toán Khoảng thời gian tính toán số lượng giao dịch (hoặc số lượng giao dịch liên quan đến thuộc tính tuỳ chỉnh). Chọn số tháng (1-24 tháng). 1 tháng

Nếu đã xác định các thuộc tính tuỳ chỉnh cho sản phẩm API của mình, bạn có thể định cấu hình tham số xếp hạng tuỳ chỉnh để xác định bộ đếm giao dịch dựa trên thuộc tính tuỳ chỉnh.

Ví dụ: bạn có thể cần phải:

  • Tính phí cho nhà phát triển một số tiền có thể thay đổi dựa trên giá trị được cung cấp trong thông báo của lệnh gọi API.
    Ví dụ: bạn có thể muốn tính phí các nhà phát triển ứng dụng dựa trên số byte được truyền trong yêu cầu API.
  • Nhóm nhiều lệnh gọi API thành một giao dịch duy nhất.
    Trong trường hợp này, hãy chọn Sử dụng tham số xếp hạng tuỳ chỉnh và chọn thuộc tính tuỳ chỉnh từ danh sách thả xuống.

Để biết thêm thông tin, hãy xem bài viết Định cấu hình gói giá bằng các thuộc tính tuỳ chỉnh.

Phiên bản cũ (Đám mây riêng tư)

Cách định cấu hình kế hoạch thông báo có thể điều chỉnh bằng giao diện người dùng Classic Edge:

  1. Chọn Adjustable Notification (Thông báo có thể điều chỉnh) trong trường Rate plan Type (Loại gói giá) trên thẻ Plan Details (Thông tin chi tiết về gói) trong cửa sổ Rate Plan (Gói giá).

    Hãy xem bài viết Tạo gói giá bằng giao diện người dùng để biết thông tin về cách truy cập cửa sổ Gói giá.

  2. Đặt trường Thời hạn gia hạn thành số tháng mà gói sẽ tự động gia hạn (trừ phi nhà phát triển chấm dứt thoả thuận trước ngày đó). Nếu bạn đặt giá trị này thành 0, thì kế hoạch sẽ vẫn có hiệu lực cho đến khi nhà phát triển chọn chấm dứt gói đó.
  3. Nhấp vào Chi tiết trong phần Gói giá chung.
  4. Đặt Cơ sở tổng hợp thành khoảng thời gian tổng hợp số lượng giao dịch. Chọn một số trong khoảng từ 1 đến 24 tháng. Giá trị này mặc định là 1 tháng.
  5. Nhấp vào Apply and Close (Áp dụng và đóng).
  6. Nhấp vào Lưu bản nháp.
  7. Chỉ xuất bản kế hoạch khi bạn hoàn toàn chắc chắn kế hoạch đó là cuối cùng. Hãy xem phần Gói giá xuất bản để biết thông tin về cách đặt Ngày xuất bản và xuất bản kế hoạch.

    Sau khi xuất bản gói giá, bạn chỉ có thể sửa đổi 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 gói giá đó và thay thế 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ông bố.

Định cấu hình kế hoạch thông báo có thể điều chỉnh bằng API

Chỉ định thông tin chi tiết về kế hoạch thông báo có thể điều chỉnh trong thuộc tính ratePlanDetails ở nội dung yêu cầu trong yêu cầu POST tới /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Để chỉ định một kế hoạch thông báo có thể điều chỉnh, hãy chỉ định các giá trị sau trong ratePlanDetails của nội dung yêu cầu:

Tài sản Giá trị
type Đặt thành USAGE_TARGET.
meteringType Đặt thành DEV_SPECIFIC.
duration Đặt thành khoảng thời gian cho cơ sở tổng hợp, cùng với durationType. Đối với các gói giá thông báo có thể điều chỉnh, hãy đặt giá trị này thành một giá trị số nguyên từ 1 đến 24.
durationType

Đặt thành khoảng thời gian cho cơ sở tổng hợp, cùng với durationType. Đối với các gói giá thông báo có thể điều chỉnh được, hãy đặt giá trị này thành MONTH.

Để biết thêm thông tin về các thuộc tính cấu hình có thể được đặt khi chỉ định chi tiết về kế hoạch thông báo có thể điều chỉnh, hãy xem phần Chế độ cài đặt cấu hình chi tiết về gói giá.

Ví dụ: nội dung sau đây xác định một kế hoạch thông báo có thể điều chỉnh với cơ sở tổng hợp được đặt thành 1 tháng.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

Đặt số lượng giao dịch mục tiêu cho mỗi nhà phát triển ứng dụng sử dụng API

Đối với mỗi nhà phát triển ứng dụng đã chấp nhận gói giá thông báo có thể điều chỉnh, bạn cần đặt số lượng giao dịch mục tiêu. Bạn có thể định cấu hình có gửi thông báo hay không và khi nào gửi thông báo dựa trên thời điểm đạt đến một tỷ lệ phần trăm của số mục tiêu, chẳng hạn như 90%, 100% hoặc 150%. Các giao dịch bổ sung sẽ không bị chặn sau khi đạt đến con số mục tiêu.

Bạn có thể đặt số lượng giao dịch mục tiêu cho một nhà phát triển ứng dụng khi nhà phát triển đó chấp nhận gói giá, và bạn có thể cập nhật giá trị này sau.

Đặt số lượng giao dịch mục tiêu khi chấp nhận gói giá

Khi chấp nhận gói giá, để thiết lập số lượng giao dịch mục tiêu, hãy chỉ định thuộc tính quotaTarget trong nội dung yêu cầu trong yêu cầu POST vào tài nguyên /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Đặt quotaTarget thành một số nguyên dương hoặc 0 để tắt thông báo cho nhà phát triển ứng dụng. Nếu không được chỉ định, quotaTarget mặc định là 0.

Ví dụ: yêu cầu sau đây đặt số lượng giao dịch mục tiêu thành 4.000 khi nhà phát triển ứng dụng chấp nhận gói thông báo có thể điều chỉnh.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Đặt số lượng giao dịch mục tiêu khi cập nhật gói giá được chấp nhận

Để thiết lập số lượng giao dịch mục tiêu, bạn có thể cập nhật gói giá được chấp nhận và chỉ định thuộc tính quotaTarget trong nội dung yêu cầu trong yêu cầu PUT cho tài nguyên /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Đặt quotaTarget thành một số nguyên dương hoặc 0 để tắt thông báo cho nhà phát triển ứng dụng. Nếu không được chỉ định, quotaTarget mặc định là 0.

{developer_rateplan_id} sẽ được trả về trong phản hồi khi bạn chấp nhận gói giá đã phát hành.

Ví dụ:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Ngoài ra, bạn có thể lấy {developer-rateplan-id} cho gói giá dành cho nhà phát triển bằng cách gửi một yêu cầu GET tới /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, trong đó {developer_id} là địa chỉ email của nhà phát triển. Để biết thêm thông tin, hãy xem phần Xem tất cả các gói giá mà nhà phát triển chấp nhận.

Ví dụ:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

Yêu cầu sau đây cập nhật số lượng giao dịch mục tiêu thành 4.000.

$ 7.0.0.0.0.vn:email:password