إعداد الإشعارات باستخدام نماذج الإشعارات

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

ما هي نماذج الإشعارات؟

توفّر ميزة تحقيق الربح مجموعة من النماذج التي تحدّد نصًا نموذجيًا لأنواع مختلفة من إشعارات الأحداث. يمكنك تخصيص أيّ من هذه النماذج من أجل:

• إرسال إشعارات إلى جميع المطوّرين بشأن أحداث مثل المنتجات الجديدة أو الإصدارات الجديدة من البنود والشروط أو خطط الأسعار الجديدة
• إشعار المطوّرين المتأثرين بأحداث مثل خطة أسعار معدَّلة
• إرسال إشعار إلى موفّر واجهة برمجة التطبيقات بشأن الأحداث المتعلّقة بالمطوّرين، مثل تسجيل مطوّر للحصول على حساب أو اشتراكه في خطة أسعار
• إرسال إشعار إلى جميع مشرفي الشركة بشأن حدث معيّن

يمكنك بدلاً من ذلك إنشاء خطاف ويب يحدّد معالج ردّ الاتصال HTTP، ثم ضبط الشرط الذي يؤدي إلى تشغيل خطاف الويب، كما هو موضّح في مقالة إعداد الإشعارات باستخدام خطافات الويب.

استكشاف صفحة "الإشعارات"

الوصول إلى صفحة "الإشعارات"، كما هو موضّح أدناه

تعديل الإشعارات

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

1. انتقِل إلى صفحة الإشعارات.
2. انقر على بجانب الإشعار الذي تريد تعديله لتوسيع تفاصيله.
3. عدِّل الحقول "الموضوع" و"النص" و"المستلِم" (إذا كان متاحًا) حسب الحاجة.

   للحصول على معلومات حول المتغيّرات التي يمكن تحديدها ضمن نموذج إشعار، يُرجى الاطّلاع على استخدام المتغيّرات في نماذج الإشعارات.

   راجِع الأقسام التالية للحصول على مزيد من المعلومات حول تعديل الإشعارات في كل فئة:

   • تعديل الإشعارات لإرسالها إلى جميع المطوّرين
   • تعديل الإشعارات لإرسالها إلى المطوّرين المتأثرين
   • تعديل الإشعارات لإرسالها إلى مقدّمي واجهات برمجة التطبيقات
4. فعِّل إشعارًا من خلال وضع علامة في مربّع الاختيار بجانبه.
5. كرِّر الخطوات من 2 إلى 4 لتعديل إشعارات إضافية.
6. انقر على حفظ لحفظ جميع التغييرات.

تظهر رسالة لتأكيد حفظ الإشعارات. قد تستغرق عملية الحفظ بضع دقائق.

تعديل الإشعارات على "إرسال إشعار إلى جميع المطوّرين"

يتم إرسال إشعارات بأنواع الأحداث التي تختارها في قسم إرسال إشعار إلى جميع المطوّرين إلى جميع المطوّرين.

من المقرّر أن يتم عرض الإشعارات في نهاية اليوم. بعد إرسال الإشعارات، يتم تلقائيًا إلغاء تحديد مربّعات الاختيار الخاصة بالحدث. عليك اختيارها مرة أخرى لجدولة الإشعارات لأنواع الأحداث المرتبطة.

يسرد الجدول التالي الإشعارات استنادًا إلى أنواع الأحداث في قسم "إرسال إشعار إلى جميع المطوّرين". لمزيد من المعلومات، يُرجى الاطّلاع على تعديل الإشعارات باستخدام واجهة المستخدم.

تعديل الإشعارات لإبلاغ المطوّرين المتأثرين

يتم إرسال إشعارات بشأن أنواع الأحداث التي تحدّدها في قسم إشعار المطوّرين المتأثرين إلى المطوّرين المتأثرين بهذه الأنواع من الأحداث فقط. على سبيل المثال، إذا اخترت حدث "خطة الأسعار المعدَّلة"، سيتم إرسال إشعار إلى المطوّرين الذين وافقوا على خطة الأسعار فقط.

يسرد الجدول التالي الإشعارات استنادًا إلى أنواع الأحداث في قسم "إرسال إشعار إلى المطوّرين المتأثرين". لمزيد من المعلومات، يُرجى الاطّلاع على تعديل الإشعارات باستخدام واجهة المستخدم.

تعديل الإشعارات لإبلاغ موفّري واجهات برمجة التطبيقات

يتم إرسال الإشعارات الخاصة بأنواع الأحداث التي تختارها في قسم إبلاغ موفّر واجهة برمجة التطبيقات إلى موفّر واجهة برمجة التطبيقات الذي تحدّده.

يسرد الجدول التالي الإشعارات استنادًا إلى أنواع الأحداث في قسم "مزوّد واجهة برمجة التطبيقات Notify". لمزيد من المعلومات، يُرجى الاطّلاع على تعديل الإشعارات باستخدام واجهة المستخدم.

تفعيل إشعار أو إيقافه

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

1. انتقِل إلى صفحة الإشعارات.
2. يمكنك تفعيل إشعار أو إيقافه من خلال وضع علامة في مربّع الاختيار بجانبه أو إزالة العلامة منه، على التوالي.
3. انقر على حفظ لحفظ جميع التغييرات.

قد تستغرق عملية الحفظ بضع دقائق. تظهر رسالة لتأكيد حفظ الإشعارات.

إعداد الإشعارات باستخدام النماذج من خلال واجهة برمجة التطبيقات

يمكنك إعداد الإشعارات باستخدام واجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية.

إدارة نماذج الإشعارات باستخدام واجهة برمجة التطبيقات

يمكنك إدارة نماذج الإشعارات باستخدام واجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية:

• عرض جميع نماذج الإشعارات باستخدام واجهة برمجة التطبيقات
• عرض نموذج إشعار باستخدام واجهة برمجة التطبيقات
• تعديل نموذج إشعار باستخدام واجهة برمجة التطبيقات

عرض جميع نماذج الإشعارات باستخدام واجهة برمجة التطبيقات

يمكنك إدراج جميع نماذج الإشعارات التي يوفّرها تحقيق الربح عن طريق إرسال طلب GET إلى /mint/organizations/{org_name}/notification-email-templates. على سبيل المثال:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

على سبيل المثال، إليك نموذج حدث يرسل إشعارًا إلى المطوّرين بشأن توفّر منتج جديد من منتجات واجهات برمجة التطبيقات:

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

عرض نموذج إشعار باستخدام واجهة برمجة التطبيقات

يمكنك عرض نموذج إشعار عن طريق إرسال طلب استرداد بيانات باستخدام GET إلى /mint/organizations/{org_name}/notification-email-templates/{template_id}، حيث {template_id} هو رقم تعريف النموذج. على سبيل المثال:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

العناصر في النماذج التي تبدأ بعلامة الدولار ($) هي متغيرات. لمزيد من المعلومات، يُرجى الاطّلاع على استخدام المتغيّرات في نماذج الإشعارات. افترِض أنّ قيم المتغيّرات في الإشعار هي كما يلي:

• ${developer.legalName}.XYZ company
• ${developer.name}.DEV1
• ${QUOTA_TYPE}.Transactions
• ${PERCENT}.90%
• ${QUOTA_UNIT}.Calls
• ${QUOTA_LIMIT}.100
• ${ratePlan.monetizationPackage.products.name}.X
• ${EXPIRY_DATE}.2016-09-30

ستكون رسالة الإشعار التي يوفّرها النموذج على النحو التالي:

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

تعديل نموذج إشعار باستخدام واجهة برمجة التطبيقات

عدِّل نموذج إشعار عن طريق إصدار طلب PUT إلى /nint/organizations/{org_name}/notification-email-templates/{template_id}. قدِّم المحتوى المعدَّل للنموذج في نص الطلب.

عند تخصيص الرسالة في نموذج إشعار، يمكنك تضمين متغيّر واحد أو أكثر. لمزيد من المعلومات، يُرجى الاطّلاع على استخدام متغير في نماذج الإشعارات.

على سبيل المثال، يعدّل الطلب التالي محتوى إشعار جديد بمنتج API:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

إدارة شروط الإشعارات والإجراءات باستخدام واجهة برمجة التطبيقات

يمكنك إدارة شروط الإشعارات وإجراءاتها باستخدام واجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية.

• إنشاء شرط إشعار وإجراء باستخدام واجهة برمجة التطبيقات
• عرض شرط الإشعار والإجراء باستخدام واجهة برمجة التطبيقات
• تعديل شرط إرسال إشعار وإجراء باستخدام واجهة برمجة التطبيقات
• حذف شرط الإشعار والإجراء باستخدام واجهة برمجة التطبيقات

إنشاء شرط إشعار وإجراء باستخدام واجهة برمجة التطبيقات

أنشئ شرط إشعار وإجراء يؤدي إلى إشعار تلقائي من خلال إرسال طلب POST إلى /mint/organizations/{org_name}/notification-conditions.

عند تقديم الطلب، حدِّد في نص الطلب الشرط الذي يؤدي إلى ظهور الإشعار، والإجراءات التي يجب اتّخاذها عند استيفاء الشرط (مثل إرسال رسالة إلكترونية تتضمّن إشعارًا).

يمكنك تحديد تفاصيل شرط الإشعار من خلال تحديد قيمة واحدة أو أكثر من قيم السمات. اطّلِع على سمات الضبط لشروط الإشعارات للاطّلاع على قائمة بالسمات. بالنسبة إلى إشعار برصد حدث، قد يتم تشغيل الشرط عند نشر منتج جديد.

عند تحديد actions، أشِر إلى نموذج الإشعار الساري. راجِع خصائص الإعدادات لإجراءات الإشعارات للاطّلاع على قائمة بالإجراءات.

على سبيل المثال، يحدّد الطلب التالي أنّه عندما تكون السمة NEW_PRODUCT وقيمة السمة PUBLISHED هي true، يتم إرسال الإشعار في النموذج الذي يحمل المعرّف 01191bf9-5fdd-45bf-8130-3f024694e63 (هذا هو DEFAULT_NEW_PRODUCT_TEMPLATE).

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

عرض شرط الإشعار والإجراء باستخدام واجهة برمجة التطبيقات

يمكنك عرض شرط إشعار وإجراء من خلال إصدار طلب استرداد بيانات باستخدام GET إلى organizations/{org_name}/notification-conditions/{condition_Id}، حيث {condition_Id} هو رقم تعريف الشرط. يتم عرض المعرّف عند إنشاء شرط الإشعار. على سبيل المثال:

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

في ما يلي مثال على الردّ:

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

تعديل شرط الإشعار والإجراء باستخدام واجهة برمجة التطبيقات

عدِّل شرط إشعار وإجراءً من خلال إصدار طلب POST إلى organizations/{org_name}/notification-conditions/{condition_Id}، حيث {condition_Id} هو رقم تعريف الشرط. يتم عرض المعرّف عند إنشاء شرط الإشعار. عند إرسال الطلب، حدِّد في نص الطلب التغييرات التي تريد إجراءها على شرط الإشعار أو الإجراء.

على سبيل المثال:

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

حذف شرط إشعار وإجراء باستخدام واجهة برمجة التطبيقات

احذف شرط إشعار بإرسال طلب DELETE إلى organizations/{org_name}notification-conditions/{condition_Id}. على سبيل المثال:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

سمات الإعداد لشروط الإشعارات

تتوفّر خصائص الإعداد التالية لشروط الإشعارات عند استخدام واجهة برمجة التطبيقات.

خصائص الإعدادات لإجراءات الإشعارات

تتوفّر خصائص الإعداد التالية لإجراءات الإشعارات عند استخدام واجهة برمجة التطبيقات.

استخدام المتغيّرات في نماذج الإشعارات

عند تعديل الرسالة في نموذج إشعار، يمكنك تضمين متغير واحد أو أكثر باستخدام لغة Spring Expression Language (SpEL) لتمثيل القيم التي يتم عرضها في عنصر Transaction.

يلخّص الجدول التالي متغيّرات نماذج الإشعارات الأكثر استخدامًا.

تخصيص عنوان البريد الإلكتروني المخصّص للرد

لتحقيق الربح، يتم ضبط عنوان noreply@apigee.com تلقائيًا لاستخدامه في إرسال الإشعارات عبر البريد الإلكتروني إلى الشركات والمطوّرين. يُرجى التواصل مع فريق دعم Apigee لضبط اسم وعنوان ردّ مخصّصَين لمؤسستك.