Đị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.
Truy cập vào tài liệu về Apigee X.
thông tin

Giới thiệu

Trong 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 việc gửi thông báo và thời điểm gửi thông báo dựa trên thời điểm đạt được 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 số lượng mục tiêu.

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

Định cấu hình gói thông báo có thể điều chỉnh, như mô tả dưới đây.

Edge

Để định cấu hình gói 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 gói giá, hãy chọn loại gói giá Thông báo có thể điều chỉnh và trong mục Thông báo có thể điều chỉnh, hãy thiết lập thông tin sau:

Trường Mô tả Mặc định
Tần suất tính toán Khoảng thời gian tính toán khối lượng giao dịch (hoặc khối lượng 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, bạn có thể định cấu hình thông số điểm xếp hạng tuỳ chỉnh để xác định bộ đếm giao dịch dựa trên một 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 biến đổ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í nhà phát triển ứng dụng dựa trên số byte được truyền trong yêu cầu API.
  • Gói nhiều lệnh gọi API thành một giao dịch.
    Trong trường hợp này, hãy chọn Sử dụng thông số điểm xếp hạng tuỳ chỉnh rồi chọn thuộc tính tuỳ chỉnh trong 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 thuộc tính tuỳ chỉnh.

Classic Edge (Đá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 Edge cũ:

  1. Chọn Thông báo có thể điều chỉnh trong trường Loại gói cước trên thẻ Thông tin chi tiết về gói trong cửa sổ Gói cước.

    Hãy xem phần 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 vào cửa sổ Gói giá.

  2. Đặt trường Thời hạn gia hạn thành số tháng mà tại đó gói được 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, gói thuê bao đó sẽ vẫn có hiệu lực cho đến khi nhà phát triển chọn kết thúc gói.
  3. Nhấp vào Chi tiết trong mục Gói giá chung.
  4. Đặt Aggregation Basis (Cơ sở tổng hợp) thành khoảng thời gian mà số lượng giao dịch được tổng hợp. Chọn một số từ 1 đến 24 tháng. Giá trị này mặc định là 1 tháng.
  5. Nhấp vào Áp dụng và đóng.
  6. Nhấp vào Lưu bản nháp.
  7. Chỉ phát hành kế hoạch khi bạn chắc chắn rằng đó là kế hoạch cuối cùng. Vui lòng 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à phát hành gói.

    Sau khi phát hành 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 gói giá đó được xuất bản, nhưng bạn có thể chấm dứt gói giá và thay thế bằng một gói giá trong tương lai, như mô tả trong phần Chấm dứt gói giá đã xuất bản.

Đị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 trong phần nội dung yêu cầu của yêu cầu POST đến /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 phần nội dung yêu cầu:

Thuộc tính 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 có thể điều chỉnh tốc độ thông báo, hãy đặt giá trị này thành một số nguyên trong khoảng 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 có thể điều chỉnh tốc độ thông báo, 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 mà bạn có thể đặt khi chỉ định thông tin chi tiết về gói thông báo có thể điều chỉnh, hãy xem phần Cài đặt cấu hình chi tiết 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 từng nhà phát triển ứng dụng bằng API

Đối với mỗi nhà phát triển ứng dụng đã chấp nhận gói tỷ lệ 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 việc gửi thông báo và thời điểm gửi thông báo dựa trên thời điểm đạt được 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 số lượng mục tiêu.

Bạn có thể đặt số giao dịch mục tiêu cho 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ố giao dịch mục tiêu khi chấp nhận gói giá

Khi chấp nhận gói giá, để đặt số lượng giao dịch mục tiêu, hãy chỉ định thuộc tính quotaTarget trong phần nội dung yêu cầu của yêu cầu POST đến tài nguyên /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Hãy đặ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 sẽ mặc định là 0.

Ví dụ: yêu cầu sau đây đặt số giao dịch mục tiêu thành 4.000 khi nhà phát triển ứng dụng chấp nhận kế hoạch 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ố giao dịch mục tiêu khi cập nhật kế hoạch giá được chấp nhận

Để đặt 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 phần nội dung yêu cầu trong yêu cầu PUT đến 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 sẽ mặc định là 0.

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

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 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 bài viết Xem tất 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 sẽ cập nhật số lượng giao dịch mục tiêu thành 4.000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password