Menyiapkan notifikasi batas untuk paket tarif

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

Anda dapat memberi tahu developer melalui email saat mereka mendekati atau telah mencapai batas tertentu paket kartu tarif Volume Banded atau Paket yang telah mereka beli. Misalnya, jika developer membeli paket band volume dengan 1.000 panggilan dalam satu paket, Anda dapat memberi tahu mereka saat panggilan mencapai 800 panggilan (penggunaan 80%) atau jika pengguna membelanjakan $500 untuk panggilan API.

Untuk menyiapkan notifikasi batas untuk paket tarif menggunakan API, lakukan langkah-langkah berikut:

  1. Sesuaikan template notifikasi yang akan digunakan untuk memberi tahu pengembang.
  2. Konfigurasi kondisi dan tindakan notifikasi.

Menyesuaikan template notifikasi

Berikut ini contoh cara menyesuaikan template notifikasi yang akan yang digunakan untuk memberi tahu pengembang. Untuk informasi selengkapnya, lihat Mengelola template notifikasi menggunakan API.

$ curl -H "Content-Type: application/json " -X POST -d \    
'{
    "name": "RATE_PLAN_LIMIT_TEMPLATE",
    "subject": "Nearing your rate plan limit",
    "htmlImage": "<p>Hi ${developer.name} - Wanted to let you know that you have used 800 API calls from your ${ratePlan.displayName} rate plan, which started on ${ratePlan.startDate} under the ${ratePlan.monetizationPackage.displayName} package and ${ratePlan.monetizationPackage.products.displayName} product. Just a friendly reminder that your API calls will be charged double after you cross 1000 calls. Thanks for using the API!</p>",
    "source": "Postman API call"
    }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
    -u email:password

Mengonfigurasi kondisi dan tindakan notifikasi

Konfigurasikan kondisi dan tindakan notifikasi menggunakan API, seperti yang dijelaskan dalam bagian Mengonfigurasi kondisi dan tindakan notifikasi menggunakan API.

Untuk memicu notifikasi terkait pembatasan paket tarif, tetapkan atribut berikut:

  • RATEPLAN - Jenis notifikasi yang akan dikirim.
  • PUBLISHED - Tetapkan atribut ini ke TRUE untuk memicu notifikasi aktif paket tarif yang dipublikasikan.

Kemudian, tentukan salah satu atribut berikut:

  • Transactions - Jumlah transaksi. Misalnya, beri tahu developer saat mencapai 800 transaksi. Harus berupa nilai bilangan bulat dan hanya > dan operator = adalah diizinkan.
  • FeeExposure - Jumlah dolar atau poin yang diakumulasikan dalam transaksi. Harus nilai bilangan bulat dan hanya > dan = diperbolehkan. FeeExposure tidak mencakup jumlah biaya penyiapan, berulang, atau penghentian. Misalnya, beri tahu developer saat biaya transaksi API mereka mencapai $500. FeeExposure penghitungan bervariasi bergantung pada tarif pajak.

Payload berikut memicu notifikasi email saat jumlah transaksi mencapai 800:

$ curl -H "Content-Type:application/json" -X POST -d \
    '{
    "notificationCondition": [
      {
        "attribute": "RATEPLAN",
        "value": "{RATE_PLAN_ID}"
      },
      {
        "attribute": "PUBLISHED",
        "value": "TRUE"
      },
      {
        "attribute": "Transactions",
        "value": "= 800"
      }     
    ],
   "actions": [{
          "actionAttribute": "DEV_ID",
          "value": "ANY",
          "templateId": "{EMAIL_TEMPLATE_ID}"
        }]
  }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
    -u email:password