Đị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 thông báo mục tiêu giao dịch của mỗi nhà phát triển ứng dụng. Bạn có thể thiết lập việc có gửi thông báo hay không và khi nào thì dựa trên khi đạt được tỷ lệ phần trăm của con số mục tiêu, chẳng hạn như 90%, 100% hoặc 150%. Thông tin khác các giao dịch sẽ không bị chặn sau khi đạt đến con số 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.

Định cấu hình gói 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 tài sản ratePlanDetails trong phần nội dung yêu cầu trong yêu cầu POST để /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 phần 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ề gói thông báo có thể điều chỉnh, xem phần Chi tiết gói giá các chế độ cài đặt cấu hình.

Ví dụ: đoạn mã sau đây xác định kế hoạch thông báo có thể điều chỉnh dựa trên cơ sở tổng hợp 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 mục tiêu số giao dịch của mỗi nhà phát triển ứng dụng bằng API

Bạn có thể đặt số lượng 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ị 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á, để đặt số lượng giao dịch mục tiêu, hãy nêu rõ thuộc tính quotaTarget trong nội dung yêu cầu trong yêu cầu POST tới 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 của ứng dụng nhà phát triển. 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 là 4.000 khi ứng dụng nhà phát triển 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

Thiết lập 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 một yêu cầu PUT cho /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} nguồn. Đặt quotaTarget thành số nguyên dương hoặc 0 để tắt 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} được trả về trong phản hồi khi bạn chấp nhận gói 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 tỷ lệ 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, xem phần Xem tất cả các gói giá được chấp nhận bởi nhà phát triể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": "15-04-2016 00:00:00",
   "limitedTarget": 4000,
   "suppressCảnh báo":false
} \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password