Kebijakan MonetizationLimitsCheck

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Ringkasan

Kebijakan MonetizationLimitsCheck memungkinkan Anda menerapkan batas monetisasi pada panggilan API yang dilakukan oleh pengembang aplikasi.

Beberapa kasus yang terjadi saat kebijakan dipicu adalah:

• Jika developer aplikasi yang mengakses API yang dimonetisasi belum membeli langganan untuk produk API terkait
• Akun developer tidak memiliki saldo yang cukup.
• Developer telah melampaui batas volume transaksi.

Untuk informasi tentang cara melampirkan kebijakan ke proxy API Anda, lihat Terapkan batas monetisasi pada proxy API.

Elemen <MonetizationLimitsCheck>

Menentukan kebijakan MonetizationLimitsCheck.

Tabel berikut memberikan deskripsi tingkat tinggi untuk elemen turunan <MonetizationLimitsCheck>:

Elemen <MonetizationLimitsCheck> menggunakan sintaksis berikut:

<?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>

Elemen ini memiliki atribut berikut yang sama untuk semua kebijakan:

Referensi elemen turunan

<DisplayName>

Gunakan selain atribut name untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama yang berbeda dan lebih terdengar alami.

Elemen <DisplayName> umum untuk semua kebijakan.

Elemen <DisplayName> menggunakan sintaksis berikut:

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

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

Elemen <DisplayName> tidak memiliki atribut atau elemen turunan.

<IgnoreUnresolvedVariables>

Menentukan apakah pemrosesan kebijakan harus dihentikan saat Apigee menemukan variabel yang belum terselesaikan.

Untuk mengabaikan variabel yang belum terselesaikan dan melanjutkan pemrosesan, tetapkan nilai ke true; jika tidak, false. Nilai defaultnya adalah true.

Menyetel <IgnoreUnresolvedVariables> ke true berbeda dengan menyetel elemen <MonetizationLimitsCheck> continueOnError hingga true. Jika Anda menetapkan continueOnError ke true, Apigee tidak akan mengabaikannya hanya variabel {i>error<i} tetapi semua kesalahannya.

Elemen <IgnoreUnresolvedVariables> menggunakan sintaksis berikut:

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

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

Menentukan variabel alur tempat Anda ingin mengambil nama entitas atau resource selama eksekusi kebijakan.

Anda hanya dapat menentukan elemen <Product> dalam elemen <Variables>. Apigee mendapatkan nama produk API dari variabel alur yang ditentukan dalam elemen <Product>. Jika Anda jangan tentukan elemen <Variables>, Apigee secara default mendapatkan nama produk API dari Variabel konteks apiproduct.name. Dengan menggunakan nama produk API, Apigee mendapatkan paket tarif yang sesuai untuk produk dan melakukan pemeriksaan batas monetisasi.

Elemen <Variables> menggunakan sintaksis berikut:

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

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

<Product>

Menentukan variabel yang memiliki nama produk API.

Elemen <Product> menggunakan sintaksis berikut:

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

Menentukan pesan respons yang ditampilkan ke klien yang meminta jika terjadi kesalahan. Anda dapat menyesuaikan respons pesan sesuai kebutuhan Anda. Untuk informasi selengkapnya tentang dan semua elemen turunannya, lihat FaultResponse.

Variabel flow

Jika Anda mengatur <MonetizationLimitsCheck> atribut atribut ContinueOnError ke benar (true), tidak ada kesalahan yang dimunculkan. Dalam hal ini, variabel alur, mint.limitsViolated, mint.isDeveloperSuspended, dan mint.limitsPolicyError akan disetel secara otomatis. Variabel-variabel ini dapat digunakan untuk melakukan penanganan pengecualian lebih lanjut jika diperlukan.