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 dari paket kartu tarif Volume Banding atau Paket yang telah mereka beli. Misalnya, jika developer membeli paket volume dengan 1.000 panggilan dalam satu paket, Anda dapat memberi tahu mereka saat mereka mencapai 800 panggilan (80% penggunaan) atau saat mereka telah 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 developer.
2. Konfigurasi kondisi dan tindakan notifikasi.

Menyesuaikan template notifikasi

Berikut adalah contoh cara menyesuaikan template notifikasi yang akan digunakan untuk memberi tahu developer. 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 Mengonfigurasi kondisi dan tindakan notifikasi menggunakan API.

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

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

Kemudian, tetapkan salah satu atribut berikut:

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

Payload berikut memicu notifikasi email ketika 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