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

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

می‌توانید از طریق ایمیل به برنامه‌نویس‌ها اطلاع دهید زمانی که نزدیک می‌شوند یا به حد معینی از طرح کارت بسته‌بندی حجم یا بسته‌ای که خریداری کرده‌اند رسیده‌اند. برای مثال، اگر توسعه‌دهندگان یک طرح باند حجمی با 1000 تماس در یک بسته خریداری کنند، می‌توانید زمانی که به 800 تماس رسیدند (80 درصد مصرف) یا زمانی که 500 دلار برای تماس‌های 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 - تعداد معاملات. به عنوان مثال، زمانی که توسعه دهندگان به 800 تراکنش رسیدند، به آنها اطلاع دهید. باید یک مقدار صحیح باشد و فقط عملگرهای > و = مجاز هستند.
  • FeeExposure - مقدار دلار یا امتیاز انباشته شده در معاملات. باید یک مقدار صحیح باشد و فقط عملگرهای > و = مجاز هستند. FeeExposure شامل مقادیر هزینه راه‌اندازی، تکرارشونده یا خاتمه نمی‌شود. به عنوان مثال، زمانی که هزینه تراکنش های API آنها به 500 دلار رسید، به توسعه دهندگان اطلاع دهید. محاسبات FeeExposure بسته به نرخ مالیات متفاوت است.

هنگامی که تعداد تراکنش‌ها به 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