Quản lý gói giá

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

Quản lý kế hoạch giá bằng giao diện người dùng và API, như mô tả trong các phần sau.

Khám phá trang gói giá

Truy cập vào trang kế hoạch giá, như mô tả bên dưới.

Tạo gói giá

Cách tạo gói giá:

1. Truy cập trang Kế hoạch giá.
2. Nhấp vào +Kế hoạch giá.
3. Định cấu hình các trường sau trong bảng điều khiển trên cùng:
   

   Trường	Mô tả	Mặc định	Bắt buộc
   Tên gói giá	Tên của gói giá. NOTE: Tên phải là duy nhất trong một gói sản phẩm API. Hai gói trong cùng một gói sản phẩm không được có cùng tên.	Không áp dụng	Có
   Loại gói giá	Loại gói giá. Chọn một giá trị trong danh sách thả xuống. Để biết danh sách các loại kế hoạch giá hợp lệ, hãy xem phần Các loại kế hoạch giá được hỗ trợ.	Không áp dụng	Có
   Gói sản phẩm	Gói sản phẩm API. Chọn một giá trị trong danh sách thả xuống. Để biết thêm thông tin về gói sản phẩm API, hãy xem bài viết Quản lý gói sản phẩm API. Nếu chọn một gói sản phẩm có nhiều sản phẩm API, bạn cần chọn định cấu hình các gói giá riêng lẻ cho từng sản phẩm API hoặc một gói giá chung áp dụng cho tất cả sản phẩm API.	Không áp dụng	Có
   Đối tượng	Đối tượng có thể truy cập vào gói giá. Chọn một trong các giá trị sau trong danh sách thả xuống: Mọi người – Tất cả nhà phát triển. Nhà phát triển – Nhà phát triển hoặc công ty. Nhập tên nhà phát triển hoặc công ty. Khi bạn nhập, danh sách các nhà phát triển/công ty có chứa chuỗi đó sẽ xuất hiện trong một trình đơn thả xuống. Nhấp vào tên của nhà phát triển hoặc công ty trong danh sách thả xuống. Danh mục nhà phát triển – Danh mục nhà phát triển. Chọn danh mục nhà phát triển trong danh sách thả xuống. Định cấu hình danh mục nhà phát triển theo yêu cầu, như mô tả trong phần Quản lý danh mục nhà phát triển.	Mọi người	Không
   Ngày bắt đầu	Ngày gói giá có hiệu lực. Nhập ngày bắt đầu hoặc chọn một ngày bằng lịch.	Hôm nay	Không
   Ngày kết thúc	Ngày kết thúc gói giá. Để chỉ định ngày kết thúc, hãy bật nút bật/tắt Có ngày kết thúc rồi nhập ngày kết thúc hoặc chọn một ngày bằng lịch. LƯU Ý: Kế hoạch giá sẽ có hiệu lực cho đến hết ngày vào ngày được chỉ định. Ví dụ: Nếu muốn hết hạn một kế hoạch giá vào ngày 1 tháng 12 năm 2018, bạn nên đặt giá trị endDate thành 2018-11-30. Trong trường hợp này, kế hoạch giá sẽ hết hạn vào cuối ngày 30 tháng 11 năm 2018; tất cả các yêu cầu vào ngày 1 tháng 12 năm 2018 sẽ bị chặn.	Không có	Không
   Hiển thị trên cổng thông tin	Đặt xem gói giá là Công khai hay Riêng tư. Xem phần Gói giá công khai so với gói giá ưu đãi chọn lọc.	Đang bật	Không

4. Định cấu hình các khoản phí cho gói giá. Xem phần Định cấu hình các khoản phí cho một kế hoạch giá.
   NOTE: Không áp dụng cho các gói thông báo có thể điều chỉnh.
5. Nếu bạn chọn một gói sản phẩm có chứa nhiều sản phẩm API, hãy đặt các lựa chọn ưu tiên sau trong phần Gói giá cụ thể hoặc chung:
   LƯU Ý: Bước này không áp dụng cho các gói thông báo có thể điều chỉnh.
   

   Trường	Mô tả	Mặc định
   Định cấu hình từng sản phẩm riêng lẻ	Cờ chỉ định có định cấu hình một kế hoạch giá riêng cho từng sản phẩm API hay không.	Đã tắt
   Định cấu hình ưu đãi freemium của từng sản phẩm riêng lẻ	Cờ chỉ định có định cấu hình gói freemium cho từng sản phẩm API hay không.	Đã tắt
   Chọn sản phẩm	Nếu bật một hoặc cả hai cờ này, bạn phải chọn từng sản phẩm riêng lẻ trong danh sách thả xuống và định cấu hình thông tin chi tiết về gói giá của sản phẩm đó. NOTE: Đảm bảo rằng bạn định cấu hình tất cả sản phẩm trong gói sản phẩm.	Không áp dụng

6. Định cấu hình thông tin chi tiết về gói giá, dựa trên loại gói giá đã chọn:
   
   • Freemium
   • Bảng giá
   • Phần doanh thu chia sẻ
   • Thông báo có thể điều chỉnh
7. Nhấp vào một trong các lựa chọn sau:
   

   Nút	Mô tả
   Lưu dưới dạng bản nháp	Lưu kế hoạch giá dưới dạng bản nháp. Các nhà phát triển ứng dụng sẽ không thấy được kế hoạch giá cho đến khi bạn xuất bản kế hoạch đó. Bạn có thể chỉnh sửa mọi trường trong kế hoạch giá nháp.
   Xuất bản kế hoạch mới	Xuất bản kế hoạch. NOTE: Sau khi xuất bản một kế hoạch giá, bạn chỉ có thể sửa đổi ngày kết thúc nếu ngày này chưa được đặt. Bạn không thể xoá một kế hoạch giá sau khi kế hoạch đó được xuất bản, nhưng bạn có thể đặt ngày hết hạn cho kế hoạch giá đó và thay thế bằng một kế hoạch giá trong tương lai, như mô tả trong phần Đặt ngày hết hạn cho kế hoạch giá đã xuất bản.

8. Đính kèm chính sách Monetization Limits Check vào các proxy API được liên kết với các sản phẩm API có trong gói giá. Chính sách Kiểm tra giới hạn kiếm tiền thực thi các giới hạn kiếm tiền đối với các proxy API và đảm bảo rằng mọi lỗi đều được ghi lại chính xác trong báo cáo phân tích và báo cáo kiếm tiền. Để biết thêm thông tin, hãy xem bài viết Thực thi hạn mức kiếm tiền trên các proxy API.

Chỉnh sửa gói giá

Bạn có thể chỉnh sửa tất cả các trường trong một kế hoạch giá nháp, ngoại trừ Gói sản phẩm, loại và đối tượng. Sau khi xuất bản một kế hoạch giá, bạn chỉ có thể chỉnh sửa ngày kết thúc và chỉ khi bạn chưa chỉ định ngày kết thúc.

Cách chỉnh sửa gói giá:

1. Truy cập trang Kế hoạch giá.
2. Nhấp vào hàng của gói giá mà bạn muốn chỉnh sửa.
   Bảng điều khiển gói giá sẽ xuất hiện.
3. Chỉnh sửa các trường của gói giá nếu cần.
   NOTE: Sau khi xuất bản một kế hoạch giá, bạn chỉ có thể sửa đổi ngày kết thúc nếu ngày này chưa được đặt.
4. Nhấp vào một trong các lựa chọn sau:

   Nút	Mô tả
   Cập nhật bản nháp (kế hoạch giá nháp)	Lưu kế hoạch giá dưới dạng bản nháp. Các nhà phát triển ứng dụng sẽ không thấy được kế hoạch giá cho đến khi bạn xuất bản kế hoạch đó. Bạn có thể chỉnh sửa mọi trường trong kế hoạch giá nháp.
   Xuất bản bản nháp (kế hoạch giá nháp)	Xuất bản gói giá. NOTE: Sau khi xuất bản một kế hoạch giá, bạn chỉ có thể sửa đổi ngày kết thúc nếu ngày này chưa được đặt. Bạn không thể xoá một kế hoạch giá sau khi xuất bản, nhưng bạn có thể đặt ngày hết hạn cho kế hoạch giá đó và thay thế bằng một kế hoạch giá trong tương lai, như mô tả trong phần Đặt ngày hết hạn cho kế hoạch giá đã xuất bản.
   Ngày kết thúc đã cập nhật (gói giá đã xuất bản)	Đặt ngày kết thúc cho một kế hoạch đã xuất bản. NOTE: Sau khi bạn đặt ngày kết thúc cho một kế hoạch giá đã xuất bản, bạn sẽ không thể sửa đổi ngày đó nữa.

Xoá gói giá nháp

Xoá một kế hoạch giá nháp nếu bạn không cần kế hoạch đó nữa.

LƯU Ý: Bạn không thể xoá một kế hoạch giá đã xuất bản.

Cách xoá kế hoạch giá ở trạng thái nháp:

1. Truy cập trang Kế hoạch giá.
2. Đặt con trỏ lên gói giá mà bạn muốn xoá để trình đơn thao tác xuất hiện.
3. Nhấp vào .
4. Nhấp vào Xoá để xác nhận thao tác.

Quản lý gói giá bằng API

Các phần sau đây mô tả cách quản lý kế hoạch giá bằng API.

Tạo gói giá bằng API

Để tạo một kế hoạch giá, hãy gửi yêu cầu POST đến /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans, trong đó {monetizationpackage_id} là mã nhận dạng của gói sản phẩm API mà bạn tạo kế hoạch giá (mã nhận dạng được trả về trong phản hồi khi bạn tạo gói sản phẩm API).

Khi tạo một gói giá, bạn phải chỉ định những thông tin sau trong nội dung yêu cầu:

• Mã tổ chức
• Mã nhận dạng gói sản phẩm API
• Tên gói giá
• Nội dung mô tả về gói giá
• Phạm vi của kế hoạch giá (áp dụng cho tất cả nhà phát triển hay chỉ áp dụng cho một nhà phát triển, công ty hoặc danh mục nhà phát triển cụ thể)
• Ngày có hiệu lực của gói giá
• Đơn vị tiền tệ của gói giá
• Có xuất bản gói giá hay không
• Kế hoạch giá là công khai hay riêng tư

Bạn có thể chỉ định các chế độ cài đặt khác (không bắt buộc), chẳng hạn như khoảng thời gian thanh toán (ví dụ: 30 ngày). Xem Thuộc tính cấu hình cho gói giá.

Nếu tạo một gói giá (ngoài gói chỉ có phí) cho một gói sản phẩm API có nhiều sản phẩm, bạn có thể áp dụng gói đó cho một sản phẩm cụ thể trong gói sản phẩm. Bạn thực hiện việc này bằng cách xác định sản phẩm trong yêu cầu. Nếu bạn không xác định sản phẩm, thì kế hoạch sẽ được áp dụng cho tất cả sản phẩm trong gói sản phẩm API.

Các phần sau đây mô tả cách tạo kế hoạch giá:

• Tạo gói giá tiêu chuẩn bằng API
• Tạo gói giá dành cho nhà phát triển hoặc công ty bằng API
• Tạo gói giá theo danh mục nhà phát triển bằng API
• Tạo một kế hoạch giá theo từng sản phẩm API bằng API
• Đặt gói giá ở chế độ công khai hoặc riêng tư bằng API

Tạo một kế hoạch giá tiêu chuẩn bằng API

Để tạo một gói giá tiêu chuẩn, hãy đặt thuộc tính type thành STANDARD, như trong ví dụ sau.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Tạo gói giá dành cho nhà phát triển hoặc công ty bằng API

Để áp dụng gói giá cho một nhà phát triển hoặc công ty cụ thể, hãy đặt giá trị type thành Developer. Bạn cũng cần xác định nhà phát triển hoặc công ty trong yêu cầu, xác định mã nhận dạng, tên pháp lý và tên của nhà phát triển hoặc công ty.

Ví dụ: đoạn trích sau đây tạo một kế hoạch giá cho nhà phát triển Dev Five:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

Tạo gói giá theo danh mục nhà phát triển bằng API

Để áp dụng kế hoạch giá cho một danh mục nhà phát triển, hãy đặt giá trị type thành Developer_Category. Bạn cũng cần xác định danh mục nhà phát triển trong yêu cầu. Ví dụ:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

Tạo một kế hoạch giá theo sản phẩm API cụ thể bằng API

Khi tạo một kế hoạch giá cho các gói sản phẩm API bao gồm nhiều sản phẩm API, bạn có thể chỉ định thông tin chi tiết về kế hoạch giá cho từng sản phẩm API.

Ví dụ: đoạn mã sau đây tạo một kế hoạch chia sẻ doanh thu với 2 sản phẩm API:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

Để thêm một sản phẩm API vào gói sản phẩm API my-package, bạn cần thêm thông tin chi tiết về gói giá cho sản phẩm API đó vào phần nội dung yêu cầu, như mô tả trong phần Thêm một sản phẩm API vào gói sản phẩm API có gói giá dành riêng cho sản phẩm API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

Đặt gói giá ở chế độ công khai hoặc riêng tư bằng API

Khi tạo một kế hoạch giá, bạn có thể chỉ định xem kế hoạch đó là công khai hay riêng tư bằng cách sử dụng thuộc tính isPrivate trong nội dung yêu cầu. Nếu bạn đặt thành true, gói giá sẽ ở chế độ riêng tư. Để biết thêm thông tin, hãy xem bài viết Gói giá công khai so với gói giá ưu đãi chọn lọc.

Ví dụ: mã sau đây sẽ tạo một mức giá ưu đãi chọn lọc:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Xuất bản gói giá bằng API

Để xuất bản một kế hoạch giá, hãy đặt giá trị thuộc tính published thành true khi bạn tạo kế hoạch giá. Nhà phát triển sẽ có thể xem gói giá từ ngày được chỉ định trong thuộc tính startDate của gói.

Ví dụ: mã sau đây tạo một kế hoạch thẻ giá và xuất bản kế hoạch đó (chỉ một phần của yêu cầu được hiển thị):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Lưu bản nháp kế hoạch giá bằng API

Để lưu một kế hoạch giá mà không cần xuất bản, hãy đặt giá trị thuộc tính published thành false khi bạn tạo kế hoạch giá.

Ví dụ: đoạn mã sau đây tạo một kế hoạch thẻ giá và lưu kế hoạch đó dưới dạng bản nháp (chỉ một phần của yêu cầu được hiển thị):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Chỉnh sửa bản nháp kế hoạch giá bằng API

Để cập nhật bản nháp gói giá, hãy gửi một yêu cầu PUT đến /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}, trong đó {package_id} là thông tin nhận dạng của gói API và {plan_Id} là thông tin nhận dạng của gói giá. Khi thực hiện việc cập nhật, bạn cần chỉ định trong nội dung yêu cầu các chế độ cài đặt đã cập nhật và mã nhận dạng của gói giá. Nếu cập nhật giá của gói giá, bạn cũng cần chỉ định mã của giá gói giá. Ví dụ: yêu cầu sau đây sẽ cập nhật giá của gói giá trong một gói giá có mã là location_flat_rate_card_plan (phần cập nhật được đánh dấu):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "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/location_flat_rate_card_plan" \
-u email:password

Phản hồi bao gồm giá của gói giá mới (chỉ một phần của phản hồi được hiển thị):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

Xem các gói giá bằng API

Bạn có thể xem các gói giá bằng cách sử dụng API kiếm tiền như mô tả trong các phần sau.

• Xem tất cả các gói giá của một tổ chức bằng API
• Xem tất cả các gói giá cho một gói sản phẩm API bằng API
• Xem gói giá cho một gói sản phẩm API bằng API
• Xem tất cả các gói giá đang hoạt động của một nhà phát triển bằng API
• Xem gói giá được chấp nhận của một nhà phát triển bằng API
• Xem gói giá được chấp nhận của một nhà phát triển có chứa một sản phẩm API bằng API
• Xem tất cả các gói giá mà nhà phát triển chấp nhận bằng API

Xem tất cả các gói giá cho một tổ chức bằng API

Để xem tất cả các gói giá của một tổ chức, hãy gửi yêu cầu GET đến /mint/organizations/{org_name}/rate-plans, trong đó {org_name} là tên của tổ chức.

Bạn có thể truyền các tham số truy vấn sau để lọc kết quả:

Ví dụ:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

Xem tất cả các gói giá của một gói sản phẩm API bằng API

Để xem tất cả các gói giá cho một gói API, hãy gửi yêu cầu GET đến /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans, trong đó {package_id} là mã nhận dạng của gói API (mã gói được trả về khi bạn tạo gói kiếm tiền).

Theo mặc định, chỉ những gói giá đang hoạt động, công khai và tiêu chuẩn mới được trả về trong kết quả. Để bao gồm:

• Kế hoạch giá nháp hoặc đã hết hạn, hãy đặt tham số truy vấn current thành false (ví dụ: ?current=false).
• Mức giá ưu đãi chọn lọc riêng, đặt tham số truy vấn showPrivate thành true (ví dụ: ?showPrivate=true).
• Tất cả các gói giá tiêu chuẩn, đặt tham số truy vấn standard thành true (ví dụ: ?standard=true).

Ví dụ:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

Xem gói giá cho một gói API bằng API

Để xem gói giá của một gói API, hãy gửi yêu cầu GET đến /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}, trong đó {package_id} là mã nhận dạng của gói API và {plan_id} là mã nhận dạng của gói giá (mã nhận dạng gói được trả về khi bạn tạo gói kiếm tiền và mã nhận dạng gói giá được trả về khi bạn tạo gói giá).

Ví dụ:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

Sau đây là ví dụ về phản hồi:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

Xem tất cả các kế hoạch giá đang hoạt động của một nhà phát triển bằng API

Để xem tất cả các kế hoạch giá đang hoạt động của một nhà phát triển, hãy gửi yêu cầu GET đến /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans, trong đó {developer_id} là địa chỉ email của nhà phát triển.

Bạn có thể truyền các tham số truy vấn sau để lọc kết quả:

Ví dụ:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

Sau đây là ví dụ về phản hồi:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

Xem gói giá được chấp nhận của một nhà phát triển bằng API

Để xem một kế hoạch giá đang hoạt động cho nhà phát triển, hãy gửi yêu cầu GET đến /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}, trong đó {developer_id} là địa chỉ email của nhà phát triển và {developer_rateplan_id} là mã của kế hoạch giá được chấp nhận sẽ đượ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ụ:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

Sau đây là ví dụ về phản hồi:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

Xem gói giá được chấp nhận của một nhà phát triển có chứa một sản phẩm API bằng API

Để xem gói giá được chấp nhận cho một nhà phát triển có chứa một sản phẩm API, hãy gửi yêu cầu GET đến /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, trong đó {developer_id} là mã nhận dạng của nhà phát triển và /{product_id} là mã nhận dạng của sản phẩm.

Theo mặc định, chỉ có một kế hoạch giá công khai được trả về trong kết quả. Để hiển thị một gói giá ưu đãi chọn lọc, hãy đặt tham số truy vấn showPrivate thành true (ví dụ: ?showPrivate=true).

Ví dụ:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

Xem tất cả các gói giá mà nhà phát triển chấp nhận bằng API

Để xem các gói giá mà nhà phát triển đã chấp nhận, hãy gửi yêu cầu GET đến /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, trong đó {developer_id} là mã nhận dạng của nhà phát triển.

Bạn có thể truyền các tham số truy vấn sau để lọc kết quả:

Ví dụ:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

Sau đây là ví dụ về phản hồi:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

Xoá bản nháp của kế hoạch giá bằng API

Để xoá một bản nháp gói giá, hãy gửi yêu cầu XOÁ đến /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}, trong đó {plan_Id} là giá trị nhận dạng của gói giá cần xoá và {package_id} là giá trị nhận dạng của gói API cho gói giá. Ví dụ:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

Thuộc tính cấu hình cho gói giá

Khi tạo một kế hoạch giá bằng API, bạn có thể chỉ định các chế độ cài đặt cấu hình sau.

Thuộc tính cấu hình cho thông tin chi tiết về gói giá

Bạn có thể chỉ định bất kỳ thuộc tính cấu hình nào sau đây trong mảng ratePlanDetails khi tạo kế hoạch giá.