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

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

ما هو رابط البيانات؟

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

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

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

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

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

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

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

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

انتقِل إلى صفحة "Webhooks" كما هو موضّح أدناه.

Edge

للوصول إلى صفحة Webhooks باستخدام واجهة مستخدم Edge:

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

تظهر صفحة Webhooks.

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

Classic Edge (سحابة خاصة)

للوصول إلى صفحة Webhooks باستخدام واجهة مستخدم Edge الكلاسيكية:

  1. سجِّل الدخول إلى http://ms-ip:9000، حيث يكون ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات الخاص بعقدة "خادم الإدارة".

  2. اختَر المشرف > الردود التلقائية على الويب.

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

تتيح لك صفحة Webhooks تنفيذ ما يلي:

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

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

  1. انتقِل إلى صفحة "الردود التلقائية على الويب".
  2. انقر على + Webhook.
  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"
}

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

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

على سبيل المثال، يُعدّل الإجراء التالي معالِج طلب إعادة الاتصال المرتبط بمحاولة webhook1:

curl -X PUT "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"
}

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

يمكنك حذف رابط ويب خارجي من خلال إرسال طلب DELETE إلى /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}"
}

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

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

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

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

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

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

Edge

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

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

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

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

Classic Edge (سحابة خاصة)

للوصول إلى صفحة "الإشعارات"، اتّبِع الخطوات التالية:

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

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

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

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

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

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

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

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

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

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

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

لحذف أحد إجراءات الإشعار وشرطه:

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

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

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

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

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

تتيح لك هذه السمة إرسال إشعار إلى المطوّرين عندما يقتربون من عدد المعاملات المستهدَف أو يحقّقونه في خطة بطاقة معدّل الإشعارات القابلة للتعديل التي اشتروها. على سبيل المثال، إذا اشترى أحد المطوّرين خطة لمعدل إشعارات قابلة للتعديل وتم ضبط عدد المعاملات المستهدف له على 1,000 معاملة، يمكنك إبلاغه عند بلوغ 800 معاملة (80% من العدد المستهدف للمعاملات) أو 1000 معاملة (100%) أو 1500 معاملة (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 تعذّر إكمال الطلب. لن يعيد النظام معالجة الطلب.