اعلان ها را با استفاده از وب هوک ها تنظیم کنید

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

وب هوک چیست؟

یک وب هوک یک کنترل کننده تماس HTTP را تعریف می کند که توسط یک رویداد راه اندازی می شود. می‌توانید به‌عنوان جایگزینی برای استفاده از الگوهای اعلان کسب درآمد، همانطور که در «تنظیم اعلان‌ها با استفاده از الگوهای اعلان» توضیح داده شده است، وبک‌هوک‌ها ایجاد کنید و آنها را برای مدیریت اعلان‌های رویداد پیکربندی کنید.

برای راه‌اندازی اعلان‌ها با استفاده از هوک‌ها، مراحل زیر را با استفاده از رابط کاربری Edge Management یا API مدیریت و کسب درآمد انجام دهید:

1. هوک‌هایی اضافه کنید که کنترل‌کننده‌های برگشت تماس را برای رویدادهای اعلان با استفاده از UI یا API تعریف می‌کنند.
2. کنترل کننده تماس را راه اندازی کنید .
3. اعلان را برای یک طرح نرخ قابل تنظیم با استفاده از UI یا API تنظیم کنید.

مدیریت وب هوک ها

وبی هوک هایی را اضافه کنید و مدیریت کنید که کنترل کننده های پاسخ تماس را برای رویدادهای اعلان با استفاده از UI یا API تعریف می کنند.

مدیریت وب هوک ها با استفاده از رابط کاربری

همانطور که در بخش‌های زیر توضیح داده شده است، وبک‌هوک‌هایی را اضافه کنید و مدیریت کنید که کنترل‌کننده‌های برگشت تماس را برای رویدادهای اعلان با استفاده از رابط کاربری تعریف می‌کنند.

• کاوش در صفحه Webhooks
• افزودن وب هوک با استفاده از رابط کاربری
• ویرایش وب هوک با استفاده از رابط کاربری
• حذف وب هوک با استفاده از رابط کاربری

کاوش در صفحه Webhooks

همانطور که در زیر توضیح داده شده است به صفحه Webhooks دسترسی پیدا کنید.

افزودن وب هوک با استفاده از رابط کاربری

برای افزودن وب هوک با استفاده از رابط کاربری:

1. به صفحه Webhooks دسترسی پیدا کنید.
2. روی + Webhook کلیک کنید.
3. اطلاعات زیر را وارد کنید (همه فیلدها الزامی است).
   

   میدان	توضیحات
   نام	نام وب هوک.
   آدرس اینترنتی	نشانی وب کنترل کننده پاسخ تماس که هنگام فعال شدن اعلان رویداد فراخوانی می شود. به تنظیم کنترل کننده پاسخ تماس مراجعه کنید.

4. روی ذخیره کلیک کنید.

وب هوک به لیست اضافه شده و به طور پیش فرض فعال می شود.

ویرایش وب هوک با استفاده از رابط کاربری

برای ویرایش یک هوک با استفاده از رابط کاربری:

1. به صفحه Webhooks دسترسی پیدا کنید.
2. مکان نما خود را روی وبی هوکی که می خواهید ویرایش کنید قرار دهید و کلیک کنید در منوی اقدامات
3. فیلدهای webhook را در صورت لزوم ویرایش کنید.
4. روی Update Webhook کلیک کنید.

فعال یا غیرفعال کردن یک هوک با استفاده از رابط کاربری

برای فعال یا غیرفعال کردن یک هوک با استفاده از رابط کاربری:

1. به صفحه Webhooks دسترسی پیدا کنید.
2. مکان نما را روی هوک قرار دهید و سوئیچ وضعیت را تغییر دهید تا آن را فعال یا غیرفعال کنید.

حذف وب هوک با استفاده از رابط کاربری

برای حذف وب هوک با استفاده از رابط کاربری:

1. به صفحه Webhooks دسترسی پیدا کنید.
2. مکان نما را روی وبی هوکی که می خواهید حذف کنید قرار دهید و کلیک کنید .

وب هوک حذف شده و از لیست حذف می شود.

مدیریت وب هوک ها با استفاده از API

همانطور که در بخش های زیر توضیح داده شده است، با استفاده از API، وب هوک ها را اضافه و مدیریت کنید.

• مشاهده تمام وب هوک ها با استفاده از API
• مشاهده وب هوک با استفاده از API
• افزودن وب هوک با استفاده از API
• ویرایش وب هوک با استفاده از API
• حذف وب هوک با استفاده از API

مشاهده تمام وب هوک ها با استفاده از API

با ارسال یک درخواست 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"
    }

  ]
}

مشاهده وب هوک با استفاده از API

با ارسال یک درخواست 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"
 }

افزودن وب هوک با استفاده از API

با ارسال یک درخواست POST به /mint/organizations/{org_name}/webhooks یک وب هوک اضافه کنید. شما باید نام webhook و 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"
}

ویرایش وب هوک با استفاده از API

با ارسال یک درخواست 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"
}

فعال یا غیرفعال کردن یک هوک با استفاده از API

با ارسال یک درخواست POST به /mint/organizations/{org_name}/webhooks/{webhook_id} یک وب‌هوک را فعال یا غیرفعال کنید، همانطور که هنگام به‌روزرسانی یک وب‌هوک انجام دادید، و مشخصه فعال در بدنه درخواست را به ترتیب روی true یا false تنظیم کنید. اگر وب هوک را غیرفعال کنید، زمانی که رویدادی رخ می دهد فعال نمی شود.

به عنوان مثال، موارد زیر 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"
}

حذف وب هوک با استفاده از API

با ارسال یک درخواست DELETE به /mint/organizations/{org_name}/webhooks/{webhook_id} یک وب هوک را حذف کنید.

برای تعیین اینکه در صورت وجود فرآیندهای در حال انجام، حذف وب هوک اجباری شود یا نه، پارامتر forceDelete query را روی true یا false تنظیم کنید. پارامتر query 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}"
}

تنظیم اعلان‌ها برای برنامه نرخ قابل تنظیم

اعلان‌ها را با استفاده از webhooks برای یک برنامه نرخ قابل تنظیم با استفاده از UI یا API تنظیم کنید.

تنظیم اعلان‌ها برای برنامه نرخ قابل تنظیم با استفاده از رابط کاربری

همانطور که در زیر توضیح داده شده است، اعلان‌ها را با استفاده از webhooks برای یک برنامه نرخ قابل تنظیم با استفاده از UI تنظیم کنید.

برای یک طرح نرخ قابل تنظیم به گفتگوی اعلان ها دسترسی پیدا کنید

همانطور که در زیر توضیح داده شده است، برای یک طرح نرخ قابل تنظیم به گفتگوی اعلان ها دسترسی پیدا کنید.

افزودن اعلان‌ها برای برنامه نرخ قابل تنظیم با استفاده از رابط کاربری

برای افزودن اعلان‌ها برای طرح نرخ قابل تنظیم، رابط کاربری:

1. به گفتگوی Notifications دسترسی پیدا کنید.
2. با تعیین درصدی از تعداد هدف تراکنش‌ها که در آن زمان می‌خواهید یک اعلان آغاز شود، شرایط اعلان را در فواصل اعلان تنظیم کنید. به طور مشخص:
   • برای تنظیم یک درصد دقیق، درصد را در فیلد At/From % وارد کرده و قسمت To % را خالی بگذارید.
   • برای تنظیم محدوده درصد، درصد شروع و پایان را به ترتیب در فیلدهای At/From % و To % وارد کنید و در قسمت Step % مقدار افزایشی را وارد کنید. به طور پیش فرض، اعلان ها با افزایش 10 درصدی در محدوده مشخص شده ارسال می شوند.

   فیلد Notify At به‌روزرسانی می‌شود تا هر درصد از تعداد مورد نظر تراکنش‌هایی را که یک رویداد را راه‌اندازی می‌کنند، منعکس کند.

3. برای تنظیم شرایط اعلان اضافی، روی +افزودن کلیک کنید و مرحله 4 را تکرار کنید.
4. با انتخاب یک یا چند وب هوک برای مدیریت مدیریت تماس در هنگام فعال شدن اعلان‌ها، اقدام اعلان را در Webhooks تنظیم کنید.
5. روی ایجاد اعلان کلیک کنید.

ویرایش اعلان‌ها برای برنامه نرخ قابل تنظیم با استفاده از رابط کاربری

برای ویرایش اعلان‌ها برای یک طرح نرخ قابل تنظیم، رابط کاربری:

1. به گفتگوی اعلان ها دسترسی پیدا کنید.
2. برای برنامه نرخ، در ستون Actions + Notify را کلیک کنید.
3. روی ویرایش کلیک کنید.
4. در صورت نیاز مقادیر را تغییر دهید.
5. روی ذخیره اعلان کلیک کنید.

حذف اعلان‌ها برای طرح نرخ قابل تنظیم با استفاده از رابط کاربری

برای حذف یک شرط و اقدام اعلان:

1. به گفتگوی اعلان ها دسترسی پیدا کنید.
2. برای برنامه نرخ، در ستون Actions + Notify را کلیک کنید.
3. روی حذف اعلان کلیک کنید.

تنظیم اعلان‌ها برای برنامه نرخ قابل تنظیم با استفاده از API

برای تنظیم یک اعلان برای یک برنامه نرخ قابل تنظیم با استفاده از API، از روشی که در مدیریت شرایط و اقدامات اعلان با استفاده از API توضیح داده شده است استفاده کنید و از ویژگی های شرح داده شده در این بخش استفاده کنید.

برای تنظیم شرایط اعلان ( notificationCondition )، از مقادیر مشخصه زیر استفاده کنید. برای اطلاعات بیشتر، به ویژگی‌های پیکربندی برای شرایط اعلان مراجعه کنید.

برای تنظیم کنش اعلان، در زیر actions مقادیر زیر را تنظیم کنید. برای اطلاعات بیشتر، به ویژگی‌های پیکربندی برای اقدامات اعلان مراجعه کنید.

در زیر مثالی از نحوه ایجاد یک شرط اعلان ارائه می شود که وقتی درصد تعداد تراکنش های مورد نظر به 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",
        }]
  }

برای کسب اطلاعات در مورد مشاهده، به‌روزرسانی، و حذف یک وضعیت و عملکرد اعلان، رجوع کنید به:

• مشاهده یک وضعیت اعلان و عملکرد با استفاده از API
• ویرایش یک وضعیت اعلان و عملکرد با استفاده از API
• حذف یک شرط اعلان و اقدام با استفاده از API

کدهای پاسخ وب هوک

در زیر کدهای پاسخ وب هوک و نحوه تفسیر آنها توسط سیستم خلاصه می شود.