Định cấu hình gói giá bằng các thuộc tính tuỳ 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 số trường hợp, bạn có thể cần bộ đếm giao dịch dựa trên biến hoặc giá trị tuỳ chỉnh. Ví dụ như bạn có thể cần phải:

• Tính phí 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 một API . Ví dụ: có thể bạn muốn tính phí nhà phát triển ứng dụng dựa trên số lượng byte được truyền trong yêu cầu API.
• Nhóm nhiều lệnh gọi API vào một giao dịch.

Khi sử dụng gói giá có thuộc tính tuỳ chỉnh, bạn có thể xác định giá trị trong thông báo của một API lệnh gọi đóng vai trò là bộ đếm và được dùng để tính số lượng giao dịch và phí.

Các gói giá sau đây có thuộc tính tuỳ chỉnh được hỗ trợ:

• Bảng giá có thuộc tính tuỳ chỉnh
• Thông báo có thể điều chỉnh bằng thuộc tính tuỳ chỉnh

Bạn có thể đặt tối đa 10 thuộc tính tuỳ chỉnh cho mỗi gói giá.

Tìm hiểu cách tính thuộc tính tuỳ chỉnh

Cách giá trị thuộc tính tuỳ chỉnh được tính vào số lượng giao dịch và khoản phí của gói giá phụ thuộc vào mô hình tính phí, như được tóm tắt trong bảng sau.

Nơi mà gói giá nhận được giá trị thuộc tính tùy chỉnh

Chính sách ghi giao dịch (trên gói sản phẩm API) cho biết vị trí kiếm tiền trong cho giá trị thuộc tính tùy chỉnh. Bạn xác định thuộc tính tùy chỉnh trong Thuộc tính tùy chỉnh của chính sách ghi lại giao dịch cho gói sản phẩm API.

Tiếp theo, bạn có thể chọn thuộc tính tuỳ chỉnh đó trong gói giá sau khi tạo một API gói sản phẩm chứa chính sách ghi lại giao dịch với đã xác định.

Sau đây là quy trình cấp cao:

1. Xác định các thuộc tính tuỳ chỉnh khi thêm sản phẩm API.
2. Tạo gói sản phẩm API chứa sản phẩm đó.
   Trong chính sách ghi lại giao dịch cho gói sản phẩm API, hãy thêm các thuộc tính tuỳ chỉnh sẽ dùng để xác định gói giá.
3. Tạo gói giá của bảng giá loại hoặc thông báo có thể điều chỉnh cho gói sản phẩm API và chỉ định thông số xếp hạng tuỳ chỉnh.

Hình sau đây thể hiện mối quan hệ giữa thuộc tính tuỳ chỉnh được xác định trong chính sách ghi lại giao dịch và cấu hình gói giá. Chiến lược phát hành đĩa đơn thông báo có thể điều chỉnh và mối quan hệ về gói giá thuộc tính tuỳ chỉnh cũng tương tự nhau, mặc dù không áp dụng giá trị giới hạn số lượng.

Cách tạo giá trị thuộc tính trong thông báo

Chính sách ghi lại giao dịch có thể tìm giá trị thuộc tính tuỳ chỉnh ở một số nơi, chẳng hạn như tiêu đề phản hồi, nội dung phản hồi hoặc các biến luồng được xác định trước trong phản hồi. (Yêu cầu không thực hiện được, vì một giao dịch sẽ không chính thức cho đến khi bạn xử lý thành công response.) Sau đây là các ví dụ minh hoạ cách thêm tiêu đề phản hồi bằng giá trị số vào thông báo. Trong cả hai trường hợp, chúng ta sẽ sử dụng Chính sách gán tin nhắn trong kết hợp với các biến.

Thêm kích thước tải trọng của yêu cầu vào tiêu đề phản hồi

Trong mỗi lời mời nhắn tin, có một biến client.received.content.length chứa số byte trong tải trọng yêu cầu. Bằng cách đính kèm chính sách Chỉ định tin nhắn vào Phản hồi của Điểm cuối proxy, chúng ta có thể tạo tiêu đề phản hồi có tên là messageSize chứa giá trị độ dài:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Thêm giá trị thuộc tính tùy chỉnh của ứng dụng vào tiêu đề

Tương tự như vậy, chúng ta có thể tạo tiêu đề bằng giá trị của thuộc tính tuỳ chỉnh trên một ứng dụng. Ví dụ: nếu bạn thêm một thuộc tính tuỳ chỉnh có tên là apprating cho mỗi nhà phát triển ứng dụng, như sau:

Khi bạn sử dụng chính sách Xác minh khoá API (bắt buộc để kiếm tiền), giá trị này là được lưu trữ trong một biến có tên là verifyapikey.{policy_name}.apprating. Sử dụng nút Chỉ định Chính sách thông báo đính kèm với phản hồi của Điểm cuối proxy, bạn có thể tạo tiêu đề có tên là apprating chứa giá trị apprating của ứng dụng:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Thiết lập gói giá

Khác với cách thiết lập thuộc tính tuỳ chỉnh như mô tả ở trên, gói giá được thiết lập theo cách tương tự như bạn vẫn thường làm (đối với những gói giá không có thuộc tính tuỳ chỉnh), nhưng phải tuân thủ các yêu cầu sau.

Định cấu hình gói giá bằng thuộc tính tuỳ chỉnh bằng giao diện người dùng

Định cấu hình gói bảng giá có thuộc tính tuỳ chỉnh bằng giao diện người dùng Edge hoặc giao diện người dùng Classic Edge, theo mô tả trong các phần sau.

Thiết lập kế hoạch thông báo có thể điều chỉnh bằng các thuộc tính tuỳ chỉnh bằng giao diện người dùng

Chỉ định thông tin chi tiết cho một gói giá bằng thuộc tính tuỳ chỉnh bằng API

Thực hiện các bước điều kiện tiên quyết sau đây:

1. Trong chính sách ghi giao dịch của một sản phẩm API, hãy thêm các thuộc tính tuỳ chỉnh sẽ dùng để xác định gói giá. Để biết chi tiết, hãy xem phần giới thiệu trong chủ đề này, cũng như cách Tạo giao dịch chính sách ghi lại. Thực hiện việc này cho từng sản phẩm API bạn muốn đưa vào gói API.
2. Sau khi các sản phẩm API và chính sách ghi giao dịch được định cấu hình chính xác theo cách bạn nếu muốn, hãy tạo gói API chứa sản phẩm. Xem phần Tạo gói API.

Tiếp theo, bạn sẽ dùng API để tạo gói giá.

Khi tạo gói giá, bạn sẽ chỉ định thông tin chi tiết về một gói giá bằng các thuộc tính tuỳ chỉnh. Bạn chỉ định các thông tin chi tiết trong thuộc tính ratePlanDetails trong nội dung yêu cầu trong một gọi đến /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Trong các chi tiết, bạn sẽ chỉ định giá trị thông số xếp hạng xác định tên của tùy chỉnh . Bạn cũng có thể chỉ định một giá trị thông số xếp hạng tổng hợp thuộc tính tuỳ chỉnh trong một khoảng thời gian chỉ định.

Xem Gói giá chế độ cài đặt cấu hình chi tiết để xem danh sách đầy đủ các lựa chọn chi tiết về gói giá.

Ví dụ: sau đây là cách tạo một Bảng giá có gói Thuộc tính tuỳ chỉnh dựa trên một có tên messageSize (xem các mục được in in đậm).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "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" \
-u email:password

Sau đây là một Thông báo có thể điều chỉnh bằng kế hoạch giá Thuộc tính tuỳ chỉnh dựa trên thuộc tính tùy chỉnh có tên là messageSize (xem mục được in in đậm).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based 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": "messageSize",
           "ratingParameterUnit": "MB",
           "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