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

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

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

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

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

سفارشی‌سازی الگوی اعلان

در زیر نمونه‌ای از نحوه سفارشی‌سازی الگوی اعلانی که برای اعلام به توسعه‌دهنده استفاده می‌شود ارائه شده است. برای اطلاعات بیشتر، مدیریت الگوهای اعلان بااستفاده از میانای برنامه‌سازی کاربردی را ببینید.

$ 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

درحال پیکربندی کردن وضعیت و کنش اعلان

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

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

  • RATEPLAN - نوع اعلانی که باید ارسال شود.
  • PUBLISHED - این مشخصه را روی «درست» تنظیم کنید تا اعلان‌ها در طرح‌های نرخ منتشرشده راه‌اندازی شود.

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

  • 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