یک اعلان محدودیت برای طرح نرخ تنظیم کنید

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید .
اطلاعات

شما می‌توانید از طریق ایمیل به توسعه‌دهندگان اطلاع دهید که چه زمانی به سقف مشخصی از طرح کارت نرخ حجمی یا بسته‌ای که خریداری کرده‌اند نزدیک می‌شوند یا به آن رسیده‌اند. برای مثال، اگر توسعه‌دهندگان یک طرح حجمی با ۱۰۰۰ تماس در یک بسته خریداری کنند، می‌توانید وقتی به ۸۰۰ تماس (۸۰٪ استفاده) رسیدند یا وقتی ۵۰۰ دلار برای تماس‌های API خرج کردند، به آنها اطلاع دهید.

برای تنظیم اعلان محدودیت برای یک طرح تعرفه با استفاده از API، مراحل زیر را انجام دهید:

  1. الگوی اعلانی را که برای اطلاع‌رسانی به توسعه‌دهنده استفاده خواهد شد، سفارشی کنید .
  2. شرط و اقدام اعلان را پیکربندی کنید .

سفارشی‌سازی قالب اعلان

در ادامه مثالی از نحوه سفارشی‌سازی الگوی اعلان که برای اطلاع‌رسانی به توسعه‌دهنده استفاده خواهد شد، ارائه شده است. برای اطلاعات بیشتر، به مدیریت الگوهای اعلان با استفاده از 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

پیکربندی شرط و اقدام اعلان

یک شرط و اقدام اعلان را با استفاده از API پیکربندی کنید، همانطور که در پیکربندی شرط‌ها و اقدامات اعلان با استفاده از API توضیح داده شده است.

برای فعال کردن اعلان برای محدودیت طرح نرخ، ویژگی‌های زیر را تنظیم کنید:

  • RATEPLAN - نوع اعلانی که باید ارسال شود.
  • PUBLISHED - برای فعال کردن اعلان‌ها در مورد طرح‌های نرخ منتشر شده، این ویژگی را روی TRUE تنظیم کنید.

سپس، یکی از ویژگی‌های زیر را مشخص کنید:

  • Transactions - تعداد تراکنش‌ها. برای مثال، وقتی به ۸۰۰ تراکنش رسیدند، به توسعه‌دهندگان اطلاع دهید. باید یک مقدار صحیح باشد و فقط عملگرهای > و = مجاز هستند.
  • FeeExposure - مقدار دلار یا امتیاز انباشته شده در تراکنش‌ها. باید یک مقدار صحیح باشد و فقط عملگرهای > و = مجاز هستند. FeeExposure شامل مبالغ کارمزد راه‌اندازی، تکرارشونده یا فسخ قرارداد نمی‌شود. برای مثال، وقتی هزینه تراکنش‌های API توسعه‌دهندگان به ۵۰۰ دلار رسید، به آنها اطلاع دهید. محاسبات FeeExposure بسته به نرخ مالیات متفاوت است.

کد مخرب زیر وقتی تعداد تراکنش‌ها به ۸۰۰ برسد، یک ایمیل اعلان ارسال می‌کند:

$ 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