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

أنت تعرض مستندات 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