كيفية تكوين التنبيهات وقوالب التنبيهات في إدارة واجهة برمجة تطبيقات Azure

ينطبق على: المطور | أساسي | الإصدار 2 الأساسي | قياسي | الإصدار 2 القياسي | بريميوم

توفر إدارة API القدرة على تكوين الإعلامات لأحداث معينة، وتكوين قوالب البريد الإلكتروني المستخدمة من أجل التواصل مع المسؤولين والمطورين لمثيل إدارة API. هذه المقالة توضح كيفية تكوين الإعلامات للأحداث المتاحة، وتوفر نظرة عامة على تكوين قوالب البريد الإلكتروني المستخدمة لهذه الأحداث.

المتطلبات الأساسية

لو لم يكن لديك مثيل خدمة إدارة واجهة برمجة التطبيقات، فأكمل التشغيل السريع التالي: إنشاء مثيل إدارة واجهة برمجة تطبيقات Azure .

الانتقال إلى مثيل إدارة واجهة برمجة التطبيقات لديك

  1. في مدخل Microsoft Azure، ابحث عن خدمات APIM وحددها.

    تحديد خدمات إدارة واجهة برمجة التطبيقات

  2. في صفحة خدمات إدارة واجهة برمجة التطبيقات، حدد مثيل إدارة واجهة برمجة التطبيقات.

    حدد مثيل خدمات إدارة واجهة برمجة التطبيقات لديك

تكوين الإخطارات في المدخل

  1. في التنقل الأيمن لمثيل APIM، حدد إخطارات لعرض الإخطارات المتوفرة.

    من الممكن تكوين قائمة الأحداث التالية للإشعارات.

    • طلبات الاشتراك (تتطلب الموافقة) - سوف يتلقى مستلمو البريد الإلكتروني المحدد والمستخدمون إخطارات بالبريد الإلكتروني حول طلبات الاشتراك لمنتجات واجهة برمجة التطبيقات التي تتطلب الموافقة.

    • الاشتراكات الجديدة - سوف يتلقى مستلمو البريد الإلكتروني المحدد والمستخدمون إخطارات بالبريد الإلكتروني عن اشتراكات منتج جديد.

    • BCC - سوف يتلقى مستلمو البريد الإلكتروني المحدد والمستخدمون نسخًا كربونية غير مرئية للبريد الإلكتروني لجميع رسائل البريد الإلكتروني المرسلة إلى المطورين.

    • رسالة إغلاق الحساب - سوف يتلقى مستلمو البريد الإلكتروني والمستخدمون المحددون إشعارات بالبريد الإلكتروني عند إغلاق الحساب.

    • الاقتراب من حد حصة الاشتراك - سوف يتلقى مستلمو البريد الإلكتروني التاليون والمستخدمون إخطارات بالبريد الإلكتروني عند اقتراب استخدام الاشتراك من حصة الاستخدام.

      إشعار

      يتم تشغيل الإشعارات من خلال سياسة الحصة على حسب الاشتراك فقط. لا تنشئ نهج الحصة على حسب المفتاح الإخطارات.

  2. حدد إخطاراً، وحدد عنوان بريد إلكتروني واحد أو أكثر ليتم إخطاره:

    • لإضافة عنوان البريد الإلكتروني للمسؤول، حدد + إضافة مسؤول.
    • لإضافة عنوان بريد إلكتروني آخر، حدد + إضافة بريد إلكتروني، وأدخل عنوان بريد إلكتروني، وحدد إضافة.
    • تابع إضافة عناوين البريد الإلكتروني حسب الحاجة.

    لقطة شاشة توضح كيفية إضافة مستلمي الإخطار في المدخل

تكوين قوالب الإعلامات

توفر APIM قوالب إعلام لرسائل البريد الإلكتروني الإدارية التي يتم إرسالها تلقائيا إلى المطورين عند الوصول إلى الخدمة واستخدامها. يتم توفير قوالب البريد الإلكتروني الآتية:

  • تمت الموافقة على تقديم معرض التطبيق (مهملة)
  • خطاب أو رسالة وداع المطور
  • حد حصة المطور من الاقتراب من الإخطار
  • رسالة ترحيب المطور
  • إعلام بتغيير البريد الإلكتروني
  • ‏‏دعوة مستخدم
  • تعليق جديد يضاف إلى المشكلة (مهمل)
  • تأكيد حساب المطور الجديد
  • استلام إصدار جديد (مهمل)
  • تم عمل تنشيط اشتراك جديد
  • قم بتأكيد تغيير كلمة المرور
  • لقد تم رفض طلب الاشتراك
  • تم استلام طلب الاشتراك

كل قالب بريد إلكتروني يحتوي على موضوع في نص عادي، وتعريف أساسي بتنسيق HTML. من الممكن تخصيص كل عنصر حسب الرغبة.

إشعار

يجب أن يكون محتوى HTML في القالب جيدا وأن يلتزم بمواصفات XML.   الحرف غير مسموح به.

لعرض قالب إعلام وتكوينه في المدخل:

  1. في القائمة اليسرى، حدد قوالب الإخطار. لقطة شاشة لقوالب الإخطار في المدخل

  2. حدد قالب إخطار، وقم بتكوين القالب باستخدام المحرر.

    لقطة شاشة لمحرر قوالب الإخطار في المدخل

    • تحتوي قائمة المعلمات على قائمة بالمعلمات، التي عند إدراجها في الموضوع أو النص الأساسي، ستستبدل القيمة المحددة عند إرسال البريد الإلكتروني.
    • لإدراج معلمة، قم بوضع المؤشر في المكان الذي تريد أن تنتقل إليه المعلمة، وقم بالنقر فوق السهم الموجود على يسار اسم المعلمة.
  3. لحفظ التغييرات التي أُجريت على نموذج البريد الإلكتروني، قم بالنقر فوق حفظ، أو لإلغاء التغييرات، قم بالنقر فوق تجاهل.

تكوين إعدادات البريد الإلكتروني

يمكنك تعديل إعدادات البريد الإلكتروني العامة للإعلامات التي تٌرسل من مثيل APIM. يمكنك تغيير عنوان البريد الإلكتروني للمسؤول واسم المؤسسة التي ترسل الإعلامات وعنوان البريد الإلكتروني الأصلي.

هام

قد يؤثر تغيير عنوان البريد الإلكتروني الأصلي على قدرة المستلمين على تلقي البريد الإلكتروني. راجع الاعتبارات في القسم التالي.

لتعديل إعدادات البريد الإلكتروني:

  1. في القائمة اليسرى، حدد قوالب الإخطار.
  2. حدد إعدادات البريد الإلكتروني.
  3. في صفحة إعدادات البريد الإلكتروني العام، أدخل قيما ل:
    • البريد الإلكتروني للمسؤول - عنوان البريد الإلكتروني لتلقي جميع إعلامات النظام والإعلامات الأخرى المكونة

    • اسم المؤسسة - اسم مؤسستك للاستخدام في مدخل المطور والإعلامات

    • عنوان البريد الإلكتروني الأصلي - قيمة From عنوان الإعلامات من مثيل APIM. ترسل API Management إعلامات نيابة عن هذا العنوان الأصلي.

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

  4. حدد حفظ.

اعتبارات تغيير عنوان البريد الإلكتروني الأصلي

قد يتأثر مستلمو إعلامات البريد الإلكتروني من APIM عند تغيير عنوان البريد الإلكتروني الأصلي.

  • تغيير إلى عنوان من - عند تغيير عنوان البريد الإلكتروني الأصلي (على سبيل المثال، إلى no-reply@contoso.comFrom سيكون noreply@contoso.com apimgmt-noreply@mail.windowsazure.comعنوان العنوان . وذلك لأن البريد الإلكتروني يتم إرساله بواسطة APIM، وليس خادم البريد الإلكتروني لعنوان البريد الإلكتروني الأصلي.

  • تم تعيين البريد الإلكتروني إلى مجلد البريد العشوائي أو البريد العشوائي - قد لا يتلقى بعض المستلمين إعلامات البريد الإلكتروني من APIM أو قد يتم إرسال رسائل البريد الإلكتروني إلى مجلد البريد العشوائي أو البريد العشوائي. يمكن أن يحدث هذا اعتمادا على إعدادات مصادقة البريد الإلكتروني SPF أو DKIM للمؤسسة:

    • مصادقة SPF - قد لا يمر البريد الإلكتروني بمصادقة SPF بعد تغيير مجال عنوان البريد الإلكتروني الأصلي. لضمان نجاح مصادقة SPF وتسليم البريد الإلكتروني، قم بإنشاء سجل TXT التالي في قاعدة بيانات DNS للمجال المحدد في عنوان البريد الإلكتروني. على سبيل المثال، إذا كان عنوان البريد الإلكتروني هو noreply@contoso.com، فاتصل بمسؤول contoso.com لإضافة سجل TXT التالي: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • مصادقة DKIM - لإنشاء توقيع صالح ل DKIM لمصادقة البريد الإلكتروني، تتطلب إدارة واجهة برمجة التطبيقات المفتاح الخاص المقترن بمجال عنوان البريد الإلكتروني الأصلي. ومع ذلك، لا يمكن حاليا تحميل هذا المفتاح الخاص في APIM. لذلك، لتعيين توقيع صالح، تستخدم إدارة واجهة برمجة التطبيقات المفتاح الخاص المقترن بالمجال mail.windowsazure.com .

الخطوات التالية