إعداد الإشعارات باستخدام الردود التلقائية على الويب

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

ما هو الردّ التلقائي على الويب؟

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

لإعداد الإشعارات باستخدام الردود التلقائية على الويب، أكمل الخطوات التالية باستخدام واجهة مستخدم Edge Management أو Management and Monetization API:

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

إدارة الردود التلقائية على الويب

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

إدارة الردود التلقائية على الويب باستخدام واجهة المستخدم

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

استكشاف صفحة الردود التلقائية على الويب

انتقِل إلى صفحة الردود التلقائية على الويب، كما هو موضَّح أدناه.

Edge

للوصول إلى صفحة الردود التلقائية على الويب باستخدام واجهة مستخدم Edge:

  1. سجِّل الدخول إلى apigee.com/edge.
  2. اختَر نشر > تحقيق الربح المادي > الردود التلقائية على الويب في شريط التنقّل الأيمن.

يتم عرض صفحة الردود التلقائية على الويب.

كما هو موضّح في الشكل، تتيح لك صفحة الردود التلقائية على الويب إجراء ما يلي:

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

للوصول إلى صفحة الردود التلقائية على الويب باستخدام واجهة مستخدم الإصدار الكلاسيكي من Edge:

  1. سجِّل الدخول إلى http://ms-ip:9000، حيث يشير ms-ip إلى عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
  2. اختَر المشرف > الردود التلقائية على الويب.

يتم عرض صفحة الردود التلقائية على الويب.

تتيح لك صفحة الردود التلقائية على الويب ما يلي:

إضافة ردّ تلقائي على الويب باستخدام واجهة المستخدم

لإضافة ردّ تلقائي على الويب باستخدام واجهة المستخدم:

  1. انتقِل إلى صفحة الردود التلقائية على الويب.
  2. انقر على + ردّ تلقائي على الويب.
  3. أدخِل المعلومات التالية (جميع الحقول مطلوبة).
    الحقل الوصف
    الاسم اسم الرد التلقائي على الويب.
    عنوان URL عنوان URL لمعالِج معاودة الاتصال الذي سيتم استدعاؤه عند تشغيل الإشعار بالحدث راجِع إعداد معالِج معاودة الاتصال.
  4. انقر على حفظ.

تتم إضافة الرد التلقائي على الويب إلى القائمة ويتم تفعيله تلقائيًا.

تعديل استخدام الردّ التلقائي على الويب في واجهة المستخدم

لتعديل ردّ تلقائي على الويب باستخدام واجهة المستخدم:

  1. انتقِل إلى صفحة الردود التلقائية على الويب.
  2. ضع مؤشر الماوس فوق الرد التلقائي على الويب الذي تريد تعديله وانقر على في قائمة الإجراءات.
  3. عدِّل حقول الرد التلقائي على الويب كما هو مطلوب.
  4. انقر على تعديل الردّ التلقائي على الويب.

تفعيل الردّ التلقائي على الويب أو إيقافه باستخدام واجهة المستخدم

لتفعيل ردّ تلقائي على الويب أو إيقافه باستخدام واجهة المستخدم:

  1. انتقِل إلى صفحة الردود التلقائية على الويب.
  2. ضَع مؤشر الماوس فوق الرد التلقائي على الويب وفعِّل مفتاح تبديل الحالة لتفعيله أو إيقافه.

حذف ردّ تلقائي على الويب باستخدام واجهة المستخدم

لحذف ردّ تلقائي على الويب باستخدام واجهة المستخدم:

  1. انتقِل إلى صفحة الردود التلقائية على الويب.
  2. ضَع مؤشر الماوس فوق الرد التلقائي على الويب الذي تريد حذفه وانقر على .

يتم حذف الرد التلقائي على الويب وإزالته من القائمة.

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

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

عرض جميع الردود التلقائية على الويب باستخدام واجهة برمجة التطبيقات

عرض جميع الردود التلقائية على الويب من خلال إصدار طلب GET إلى /mint/organizations/{org_name}/webhooks. مثال:

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

فيما يلي مثال على الرد الذي تم إرجاعه:

{
  "totalRecords": 2,
  "webhooks": [
    {
      "created": 1460162656342,
      "enabled": false,
      "id": "21844a37-d26d-476c-93ed-38f3a4b24691",
      "name": "webhook1",
      "postUrl": "http://mycompany.com/callbackhandler1",
      "updated": 1460162656342,
      "updatedBy": "joe@example.com"
    },
        {
      "created": 1460138724352,
      "createdBy": "joe@example.com",
      "enabled": true,
      "id": "a39ca777-1861-49cf-a397-c9e92ab3c09f",
      "name": "webhook2",
      "postUrl": "http://mycompany.com/callbackhandler2",
      "updated": 1460138724352,
      "updatedBy": "joe@example.com"
    }

  ]
}

عرض رد تلقائي على الويب باستخدام واجهة برمجة التطبيقات

يمكنك عرض ردّ تلقائي واحد على الويب عن طريق إصدار طلب GET إلى /mint/organizations/{org_name}/webhooks/{webhook_id}.

مثال:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/21844a37-d26d-476c-93ed-38f3a4b24691" \
  -H "Content-Type: application/json " \
  -u email:password

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

{
   "created": 1460162656342,
   "enabled": false,
   "id": "21844a37-d26d-476c-93ed-38f3a4b24691",
   "name": "webhook1",
   "postUrl": "http://mycompany.com/callbackhandler1",
   "updated": 1460162656342,
   "updatedBy": "joe@example.com"
 }

إضافة ردّ تلقائي على الويب باستخدام واجهة برمجة التطبيقات

أضِف ردًّا تلقائيًا على الويب عن طريق إصدار طلب POST إلى /mint/organizations/{org_name}/webhooks. يجب ضبط اسم الرد التلقائي على الويب وعنوان URL لمعالِج معاودة الاتصال الذي سيتم طلبه عند تشغيل إشعار الحدث.

على سبيل المثال، يؤدي ما يلي إلى إنشاء ردّ تلقائي على الويب باسم webhook3 ويخصِّص callbackhandler3 للردّ التلقائي على الويب:

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks"
  -H "Content-Type: application/json "
  -d '{
    "name": "webhook3",
    "postURL": "http://mycompany.com/callbackhandler3"
    }' \
    -u email:password

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

{
  "created": 1460385534555,
  "createdBy": "joe@example.com",
  "enabled": false,
  "id": "0a07eb1f-f485-4539-8beb-01be449699b3",
  "name": "webhook3",
  "orgId": "myorg",
  "postUrl": "http://mycompany.com/callbackhandler3",
  "updated": 1460385534555,
  "updatedBy": "joe@example.com"
}

تعديل رد تلقائي على الويب باستخدام واجهة برمجة التطبيقات

يمكنك تعديل ردّ تلقائي على الويب من خلال إصدار طلب POST إلى /mint/organizations/{org_name}/webhooks/{webhook_id}. تمرير التعديلات في نص الطلب

على سبيل المثال، يعدّل ما يلي معالج معاودة الاتصال المرتبط بـ webhook1:

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/0a07eb1f-f485-4539-8beb-01be449699b3" \
  -H "Content-Type: application/json " \
  -d '{
    "postURL": "http://mycompany.com/callbackhandler4"
  }' \
  -u email:password

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

{
  "created": 1460385534555,
  "enabled": false,
  "id": "0a07eb1f-f485-4539-8beb-01be449699b3",
  "name": "webhook3",
  "orgId": "myorg",
  "postUrl": "http://mycompany.com/callbackhandler4",
  "updated": 1460385534555,
  "updatedBy": "joe@example.com"
}

تفعيل أو إيقاف الردّ التلقائي على الويب باستخدام واجهة برمجة التطبيقات

يمكنك تفعيل الردّ التلقائي على الويب أو إيقافه عن طريق إصدار طلب POST إلى /mint/organizations/{org_name}/webhooks/{webhook_id}، كما فعلت عند تعديل ردّ تلقائي على الويب، وضبط السمة المفعَّلة في نص الطلب على "صحيح" أو "خطأ"، على التوالي. إذا أوقفت الرد التلقائي على الويب، لن يتم تشغيله عند وقوع حدث.

على سبيل المثال، يعمل ما يلي على تفعيل webhook3:

curl -X POST  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/0a07eb1f-f485-4539-8beb-01be449699b3" \
  -H "Content-Type: application/json " \
  -d '{
    "enabled": "true"
  }' \
  -u email:password

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

{
  "created": 1460385534555,
  "enabled": true,
  "id": "0a07eb1f-f485-4539-8beb-01be449699b3",
  "name": "webhook3",
  "orgId": "myorg",
  "postUrl": "http://mycompany.com/callbackhandler4",
  "updated": 1460385534555,
  "updatedBy": "joe@example.com"
}

حذف ردّ تلقائي على الويب باستخدام واجهة برمجة التطبيقات

يمكنك حذف ردّ تلقائي على الويب عن طريق إصدار طلب "حذف" إلى /mint/organizations/{org_name}/webhooks/{webhook_id}.

لتحديد ما إذا كنت تريد فرض حذف الردّ التلقائي على الويب في حال كانت هناك عمليات قيد التقدّم، اضبط مَعلمة طلب البحث forceDelete على true أو false. تكون معلَمة طلب البحث forceDelete مفعّلة (true) بشكل تلقائي.

على سبيل المثال، يؤدي ما يلي إلى حذف webhook3:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/21844a37-d26d-476c-93ed-38f3a4b24691" \
  -H "Content-Type: application/json " \
  -u email:password

إعداد معالج معاودة الاتصال

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

{
        "orgName": "{org_id}",
        "developerEmail": "{dev_email}",
        "developerFirstName": "{first_name}",
        "developerLastName": "{last_name}",
        "companyName": "{company_name}",
        "applicationName": "{app_name}",
        "packageName": "{api_package_name}",
        "packageId": "{api_package_id}",
        "ratePlanId": "{rateplan_id}",
        "ratePlanName": "{rateplan_name}",
        "ratePlanType": "{rateplan_type}",
        "developerRatePlanQuotaTarget": {quota_target},
        "quotaPercentUsed": {percentage_quota_used},
        "ratePlanStartDate": {rateplan_startdate}, 
        "ratePlanEndDate": {rateplan_enddate},
        "nextBillingCycleStartDate": {next_billing_cycle_startdate},
        "products": ["{api_product_name}","{api_product_name}"],
        "developerCustomAttributes": [],
        "triggerTime": {trigger_time},
        "triggerReason": "{trigger_reason}",
        "developerQuotaResetDate": "{devquota_resetdate}"
}

إعداد الإشعارات لخطة أسعار قابلة للتعديل

إعداد الإشعارات باستخدام الردود التلقائية على الويب لخطة أسعار قابلة للتعديل باستخدام واجهة المستخدم أو API.

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

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

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

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

Edge

للدخول إلى مربع حوار الإشعارات باستخدام واجهة مستخدم Edge:

  1. يمكنك إنشاء خطة معدّلة للإشعارات قابلة للتعديل ونشرها، على النحو الموضَّح في تحديد تفاصيل خطة الإشعارات القابلة للتعديل.
  2. انتقِل إلى صفحة "خطط الأسعار" بالنقر على نشر > تحقيق الربح > خطط الأسعار في شريط التنقّل الأيمن.
  3. ضَع مؤشر الماوس فوق الخطة المنشورة لمعدّل الإشعارات القابلة للتعديل لعرض الإجراءات.
  4. انقر على +إشعار.

    يتم عرض مربع حوار الإشعارات.

    ملاحظة: يجب نشر خطة السعر لكي يتم عرض الإجراء "+إشعار".

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

للوصول إلى صفحة الإشعارات:

  1. يمكنك إنشاء خطة معدل الإشعارات القابلة للتعديل على النحو الموضَّح في تحديد تفاصيل خطة الإشعارات القابلة للتعديل.
  2. اختَر نشر > الحِزم لعرض خطط الأسعار.
  3. انقر على +إشعار في عمود "الإجراءات" لخطة السعر.

    يتم عرض مربع حوار الإشعارات.

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

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

  1. انتقِل إلى مربّع حوار الإشعارات.
  2. اضبط شرط الإشعار ضمن فواصل الإشعارات من خلال تحديد نسبة مئوية من العدد المستهدف من المعاملات التي تريد خلالها عرض الإشعار. وعلى وجه التحديد:
    • لضبط نسبة مئوية دقيقة، أدخِل النسبة المئوية في الحقل At/من % واترك الحقل إلى % فارغًا.
    • لضبط نطاق للنسبة المئوية، أدخِل النسبة المئوية للبداية والنهاية في الحقلَين @/من وإلى % على التوالي، وقيمة إضافية في حقل النسبة المئوية للخطوة. يتم تلقائيًا إرسال الإشعارات بزيادات بنسبة %10 ضمن النطاق المحدّد.

    يتم تعديل الحقل Notify At ليعكس كل نسبة مئوية من العدد المستهدف للمعاملات التي ستؤدي إلى بدء حدث.

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

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

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

  1. انتقِل إلى مربّع حوار الإشعارات.
  2. انقر على +إشعار في عمود "الإجراءات" لخطة السعر.
  3. انقر على تعديل.
  4. عدِّل القيم حسب الحاجة.
  5. انقر على حفظ الإشعار.

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

لحذف شرط الإشعار وتنفيذه:

  1. انتقِل إلى مربّع حوار الإشعارات.
  2. انقر على +إشعار في عمود "الإجراءات" لخطة السعر.
  3. انقر على حذف الإشعار.

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

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

لإعداد حالة الإشعار (notificationCondition)، استخدِم قيم السمات التالية. لمزيد من المعلومات، يُرجى الاطّلاع على خصائص الإعدادات لشروط الإشعارات.

السمة القيمة
RATEPLAN رقم تعريف خطة معدّل الإشعارات القابل للتعديل
PUBLISHED TRUE للإشارة إلى ضرورة نشر خطة معدّل الإشعارات القابل للتعديل.
UsageTarget النسبة المئوية لعدد المعاملات المستهدفة التي تريد فيها عرض إشعار.

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

  • لضبط نسبة مئوية دقيقة، أدخِل %= n. على سبيل المثال، سيرسل %= 80 إشعارات عندما تصل النسبة المئوية من العدد المستهدف من المعاملات إلى %80.
  • لضبط نطاق نسبة مئوية، أدخِل النسب المئوية للبداية والنهاية، والقيمة التي تريد الزيادة من خلالها على النحو التالي: %= start to end by n. على سبيل المثال، سترسل القيمة %= 80 to 100 by 10 إشعارات عندما تصل النسبة المئوية للعدد المستهدف من المعاملات إلى 80% و 90% و 100%.

لإعداد إجراء الإشعار، اضبط القيم التالية ضِمن actions. لمزيد من المعلومات، يُرجى الاطّلاع على خصائص الإعدادات لإجراءات الإشعارات.

السمة القيمة
actionAttribute WEBHOOK لتشغيل ردّ تلقائي على الويب
value رقم تعريف الرد التلقائي على الويب الذي حدّدته في القسم السابق، إنشاء الردود التلقائية على الويب باستخدام واجهة برمجة التطبيقات.

في ما يلي مثال على كيفية إنشاء شرط إشعار يؤدّي إلى تلقّي ردّ تلقائي على الويب عندما تصل النسبة المئوية للعدد المستهدَف من المعاملات إلى 80% و90% و100% و110% و120%.

{
    "notificationCondition": [
      {
        "attribute": "RATEPLAN",
        "value": "123456"
      },
      {
        "attribute": "PUBLISHED",
        "value": "TRUE"
      },
      {
        "attribute": "UsageTarget",
        "value": "%= 80 to 120 by 10"
      }
    } 
    ],
   "actions": [{
          "actionAttribute": "WEBHOOK",
          "value": "b0d77596-142e-4606-ae2d-f55c3c6bfebe",
        }]
  }

للحصول على معلومات حول عرض حالة الإشعار وإجراءه وتحديثهما وحذفهما، راجع:

رموز الاستجابة للردّ التلقائي على الويب

يلخّص ما يلي رموز الاستجابة للردّ التلقائي على الويب وكيفية تفسير النظام لها.

رمز الاستجابة الوصف
2xx تم الإجراء بنجاح
5xx

تعذّر الطلب. سيعيد النظام محاولة الطلب ثلاث مرات كحد أقصى خلال فواصل زمنية تبلغ 5 دقائق.

ملاحظة: تبلغ مهلة القراءة والاتصال لطلبات الردّ التلقائي على الويب 3 ثوانٍ لكلّ منها، ما يمكن أن يؤدي إلى تعذّر إتمام الطلبات.

Other response تعذّر الطلب. لن يعيد النظام محاولة الطلب.