Menegakkan batas monetisasi di proxy API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Terapkan batas monetisasi dengan melampirkan kebijakan ke proxy API yang terkait dengan produk API yang dimonetisasi seperti yang dijelaskan di bagian berikut.

Menambahkan kebijakan autentikasi

Monetisasi Apigee menggunakan kebijakan VerifyAPIKey atau VerifyAccessToken untuk menentukan apakah permintaan masuk dapat dimonetisasi atau tidak dengan memeriksa paket tarif aktif yang dipublikasikan.

Lampirkan kebijakan VerifyAPIKey atau kebijakan VerifyAccessToken ke proxy API dengan salah satu cara berikut:

  • Saat membuat proxy API menggunakan wizard Buat proxy, pilih Kunci API atau OAuth 2.0 di bagian Keamanan: Otorisasi pada halaman Kebijakan umum. Contoh:

    Halaman kebijakan umum dari wizard Create proxy dengan Kunci API dipilih

  • Saat mengembangkan proxy API, lampirkan kebijakan VerifyAPIKey atau kebijakan VerifyAccessToken ke alur permintaan sebagai kebijakan pertama di PreFlow proxy API. Contoh:

    Tab developer di editor proxy API menampilkan kebijakan VerifyAPIKey yang dilampirkan ke PreFlow

Untuk informasi selengkapnya, lihat:

Menegakkan langganan developer untuk produk API

Lampirkan kebijakan MonetizationLimitsCheck ke proxy API untuk menerapkan langganan developer ke produk API. Secara khusus, kebijakan ini akan dipicu jika developer aplikasi yang mengakses API belum membeli langganan produk API terkait. Dalam hal ini, kebijakan MonetizationLimitsCheck memunculkan kesalahan dan memblokir panggilan API.

Jika tidak ada paket tarif monetisasi untuk produk API yang diambil selama eksekusi panggilan proxy, produk tersebut dianggap tidak dimonetisasi, kebijakan MonetizationLimitsCheck tidak akan mengambil data lebih lanjut, dan kebijakan tersebut tidak akan berpengaruh.

Saat Anda menerapkan kebijakan MonetizationLimitsCheck ke proxy API, variabel alur mint.limitscheck.* dan mint.subscription_* akan diisi, seperti yang dijelaskan dalam Men-debug kebijakan MonetizationLimitsCheck dan referensi variabel alur mint.

Lampirkan kebijakan MonetizationLimitsCheck ke proxy API dengan salah satu cara berikut:

  • Saat membuat proxy API menggunakan wizard Buat proxy, pilih Terapkan batas monetisasi di halaman Kebijakan umum, seperti yang ditunjukkan pada gambar berikut.

    Halaman kebijakan umum dari wizard Buat proxy dengan Enforce Limits Check dipilih

  • Saat mengembangkan proxy API, lampirkan MonetizationLimitsCheckPolicy ke alur permintaan di PreFlow proxy API setelah kebijakan VerifyAPIKey atau VerifyAccessToken, seperti yang ditunjukkan dalam gambar berikut.

    Tab developer di editor proxy API yang menampilkan kebijakan MonetizationLimitsCheck yang dilampirkan ke PreFlow setelah kebijakan VerifyAPI

Untuk informasi selengkapnya, lihat:

Menegakkan kuota monetisasi di proxy API

Kuota menentukan jumlah permintaan yang diizinkan untuk produk API selama jangka waktu tertentu. Untuk menerapkan kuota monetisasi, sebaiknya Anda menetapkan nilai kuota saat membuat produk API.

Penentuan nilai kuota untuk produk API tidak akan otomatis menerapkan pembatasan jumlah panggilan yang dapat dilakukan melalui produk API tersebut. Anda juga harus menambahkan kebijakan Kuota ke proxy API yang dirujuk oleh produk API untuk memastikan nilai kuota yang ditentukan pada level produk API diterapkan.

Lampirkan kebijakan Kuota ke proxy API dengan salah satu cara berikut:

  • Saat membuat proxy API menggunakan wizard Buat proxy, pilih Terapkan kuota per aplikasi di bagian Kuota pada halaman Kebijakan umum, seperti yang ditunjukkan pada gambar berikut.

    Halaman kebijakan umum di wizard Buat proxy dengan Terapkan kuota per aplikasi dipilih

  • Saat mengembangkan proxy API, lampirkan kebijakan Kuota ke alur permintaan di PreFlow proxy API setelah kebijakan VerifyAPIKey atau VerifyAccessToken, seperti yang ditunjukkan dalam gambar berikut.

    Tab developer di editor proxy API yang menampilkan kebijakan Kuota yang terlampir ke PreFlow

Edit kebijakan Kuota untuk mengaktifkan elemen <UseQuotaConfigInAPIProduct> menggunakan konfigurasi kuota yang ditentukan pada level produk API.

Contoh:

<Quota continueOnError="false" enabled="true" name="impose-quota">
    <DisplayName>Impose Quota</DisplayName>
    <UseQuotaConfigInAPIProduct stepName="verify-api-key">
        <DefaultConfig>
            <Allow>10000</Allow>
            <Interval>1</Interval>
            <TimeUnit>week</TimeUnit>
        </DefaultConfig>
    </UseQuotaConfigInAPIProduct>
    <Distributed>true</Distributed>
    <Synchronous>true</Synchronous>
    <StartTime>2021-01-01 12:00:00</StartTime>
</Quota>

Saat Anda melampirkan kebijakan Kuota ke proxy API, variabel alur ratelimit.* akan diisi, seperti yang dijelaskan dalam artikel Men-debug kebijakan Kuota dan referensi variabel alur Kebijakan kuota.

Untuk informasi selengkapnya, lihat: