Đị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 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 thời điểm và tần suất gửi thông báo dựa trên thời điểm đạt được 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 khác sẽ không bị chặn sau khi đạt được số lượng 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.

Đị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 trong 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 nội dung yêu cầu:

Để 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 thông tin 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 thông tin chi tiết về kế hoạch giá.

Ví dụ: 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

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ố lượng giao dịch mục tiêu khi chấp nhận gói giá

Khi chấp nhận kế hoạch giá, để đặt 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 đến tài nguyên /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Đặt quotaTarget thành 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 bạn không 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 là 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 gói thuê bao đượ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 nội dung yêu cầu trong yêu cầu PUT đối với tài nguyên /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Đặt quotaTarget thành 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 bạn không 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 kế hoạch giá đã xuất bản.

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 đến /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 sẽ cập nhật số 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