إعداد إشعار للحد الأقصى لخطة أسعار

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

يمكنك إعلام المطوّرين عبر البريد الإلكتروني عند اقترابهم من حدّ معيّن أو وصولهم إلى حدّ معيّن من خطة بطاقة السعر "نطاق الحجم" أو "حزمة السعر الخاصة بالحزمة" التي اشتروها. على سبيل المثال، إذا اشترى المطوّرون خطة واسعة النطاق تضمّ 1,000 مكالمة في حزمة واحدة، يمكنك إرسال إشعار إليهم عندما يصلون إلى 800 مكالمة (استخدام% 80) أو عندما ينفقون 500 دولار أمريكي على طلبات البيانات من واجهة برمجة التطبيقات.

لإعداد إشعار حول الحدّ الأقصى لخطة أسعار باستخدام واجهة برمجة التطبيقات، اتّبِع الخطوات التالية:

  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 - عدد المعاملات على سبيل المثال، يمكنك إعلام المطوّرين عند بلوغهم 800 معاملة. يجب أن تكون قيمة عدد صحيح، ويُسمح فقط باستخدام عاملَي التشغيل > و=.
  • FeeExposure - مبلغ الدولارات أو النقاط المتراكمة من المعاملات ويجب أن تكون قيمة عدد صحيح ويُسمح فقط باستخدام عاملَي التشغيل > و=. لا يتضمّن FeeExposure مبالغ رسوم الإعداد أو الأرباح المتكررة أو رسوم الإنهاء. على سبيل المثال، يمكنك إعلام المطوّرين عندما تصل تكلفة معاملات واجهة برمجة التطبيقات إلى 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