Chính sách MonetizeLimitsCheck

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Tổng quan

Chính sách MonetizationLimitsCheck cho phép bạn thực thi các giới hạn kiếm tiền đối với các lệnh gọi API do nhà phát triển ứng dụng thực hiện.

Sau đây là một số trường hợp mà chính sách được kích hoạt:

• Nếu nhà phát triển ứng dụng truy cập vào API kiếm tiền chưa mua gói thuê bao cho sản phẩm API được liên kết
• Tài khoản của nhà phát triển không có đủ số dư.
• Nhà phát triển đã vượt quá giới hạn số lượng giao dịch.

Để biết thông tin về cách đính kèm chính sách vào proxy API của bạn, hãy xem phần Áp dụng giới hạn kiếm tiền đối với proxy API.

Phần tử <MonetizationLimitsCheck>

Chỉ định chính sách MonetizeLimitsCheck.

Bảng sau đây cung cấp nội dung mô tả tổng quan về các phần tử con của <MonetizationLimitsCheck>:

Phần tử <MonetizationLimitsCheck> sử dụng cú pháp sau:

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="POLICY_NAME">
    <DisplayName>DISPLAY_NAME</DisplayName>
    <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
    <Variables>
        <Product>VARIABLE_NAME</Product>
    </Variables>
    <FaultResponse>
        <Set>
            <Payload contentType="text/xml">
                <error>
                    <messages>
                        <message>MESSAGE_TEXT</message>
                        <message>MESSAGE_TEXT</message>
                    </messages>
                </error>
            </Payload>
            <StatusCode>HTTP_STATUS</StatusCode>
            <ReasonPhrase>REASON_TEXT</ReasonPhrase>
        </Set>
    </FaultResponse>
</MonetizationLimitsCheck>

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="Monetization-Limits-Check">
    <DisplayName>Monetization Limits Check</DisplayName>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <Variables>
        <Product>myproductvar.name</Product>
    </Variables>
	<FaultResponse>
	        <Set>
	            <Payload contentType="text/xml">
	                <error>
	                    <messages>
	                        <message>Developer has reached usage quota</message>
	                        <message>Is Developer Suspended - {monetizationLimits.isDeveloperSuspended} </message>
	                    </messages>
	                </error>
	            </Payload>
	            <StatusCode>403</StatusCode>
	            <ReasonPhrase>Forbidden</ReasonPhrase>
	        </Set>
	</FaultResponse>
 </MonetizationLimitsCheck>

Phần tử này có các thuộc tính chung cho tất cả các chính sách:

Tham chiếu phần tử con

<DisplayName>

Sử dụng cùng với thuộc tính name để gắn nhãn cho chính sách này bằng một tên khác nghe tự nhiên hơn trong trình chỉnh sửa proxy giao diện người dùng quản lý.

Phần tử <DisplayName> là phần tử chung cho mọi chính sách.

Phần tử <DisplayName> sử dụng cú pháp sau:

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

Phần tử <DisplayName> không có thuộc tính hoặc phần tử con.

<IgnoreUnresolvedVariables>

Xác định xem có nên dừng xử lý chính sách hay không khi Apigee gặp phải một biến chưa được giải quyết.

Để bỏ qua các biến chưa được giải quyết và tiếp tục xử lý, hãy đặt giá trị thành true; nếu không, hãy đặt giá trị false. Giá trị mặc định là true.

Việc đặt <IgnoreUnresolvedVariables> thành true sẽ khác với việc đặt continueOnError của phần tử <MonetizationLimitsCheck> thành true. Nếu bạn đặt continueOnError thành true, Apigee sẽ không chỉ bỏ qua các lỗi về biến mà còn bỏ qua tất cả các lỗi.

Phần tử <IgnoreUnresolvedVariables> sử dụng cú pháp sau:

<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

Chỉ định các biến luồng mà bạn muốn tìm nạp thực thể hoặc tên tài nguyên trong quá trình thực thi chính sách.

Bạn chỉ có thể chỉ định phần tử <Product> trong phần tử <Variables>. Apigee lấy tên sản phẩm API từ biến luồng được chỉ định trong phần tử <Product>. Nếu bạn không chỉ định phần tử <Variables>, thì theo mặc định, Apigee sẽ lấy tên sản phẩm API từ biến ngữ cảnh apiproduct.name. Bằng cách sử dụng tên sản phẩm API, Apigee sẽ nhận được gói giá tương ứng cho sản phẩm và tiến hành kiểm tra hạn mức kiếm tiền.

Phần tử <Variables> sử dụng cú pháp sau:

<Variables>
    <Product>VARIABLE_NAME</Product>
</Variables>

<Variables>
    <Product>myproductvar.name</Product>
</Variables>

<Product>

Chỉ định biến có tên sản phẩm API.

Phần tử <Product> sử dụng cú pháp sau:

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

Xác định thông báo phản hồi được trả về ứng dụng yêu cầu nếu xảy ra lỗi. Bạn có thể tuỳ chỉnh tin nhắn trả lời dựa trên yêu cầu của mình. Để biết thêm thông tin về phần tử và tất cả các phần tử con của phần tử đó, hãy xem FaultResponse.

Biến luồng

Nếu bạn đặt thuộc tính ContinueOnError của phần tử <MonetizationLimitsCheck> thành true (đúng) thì sẽ không có lỗi nào xảy ra. Trong trường hợp này, các biến luồng mint.limitsViolated, mint.isDeveloperSuspended và mint.limitsPolicyError sẽ được đặt tự động. Bạn có thể dùng các biến này để xử lý thêm trường hợp ngoại lệ nếu cần.