راه‌اندازی اعلان‌ها بااستفاده از وب‌قلاب‌ها

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

وب‌قلاب چیست؟

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

برای راه‌اندازی اعلان‌ها بااستفاده از وب‌قلاب‌ها، مراحل زیر را بااستفاده از «واسط کاربر مدیریت Edge» یا «میانای برنامه‌سازی کاربردی مدیریت و درآمدزایی» تکمیل کنید:

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

مدیریت وب‌قلاب‌ها

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

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

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

• کاوش صفحه Webhooks
• افزودن وب‌قلاب بااستفاده از میانای کاربر
• ویرایش وب‌قلاب بااستفاده از میانای کاربر
• حذف یک وب‌قلاب بااستفاده از میانای کاربر

کاوش صفحه وب‌قلاب‌ها

همان‌طور که در زیر توضیح داده شده است، به صفحه «قلاب‌های وب» دسترسی پیدا کنید.

افزودن وب‌قلاب بااستفاده از واسط کاربر

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

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

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

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

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

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

برای ویرایش یک وب‌قلاب بااستفاده از میانای کاربر:

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

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

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

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

حذف وب‌قلاب بااستفاده از واسط کاربر

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

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

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

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

همان‌طور که در بخش‌های زیر توضیح داده شده است، بااستفاده از 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"
    }

  ]
}

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

با صدور درخواست 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، وب‌قلابی اضافه کنید. باید نام وب‌قلاب و نشانی وب کنترل‌کننده تماس برگشتی را که هنگام راه‌اندازی اعلان رویداد فراخوانی می‌شود ارائه دهید.

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

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

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

راه‌اندازی اعلان‌ها برای طرح نرخ متغیر

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

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

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

دسترسی به کادر گفتگوی «اعلان‌ها» برای طرح نرخ متغیر

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

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

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

1. به کادر گفتگوی اعلان‌ها دسترسی پیدا کنید.
2. با مشخص کردن درصدی از تعداد هدف تراکنش‌ها که می‌خواهید اعلان در آن زمان راه‌اندازی شود، شرایط اعلان را در بخش فاصله‌های اعلان تنظیم کنید. به‌طور خاص:
   • برای تنظیم درصد دقیق، درصد را در فیلد در/از % وارد کنید و فیلد تا % را خالی بگذارید.
   • برای تنظیم محدوده درصد، درصد شروع و پایان را به‌ترتیب در فیلدهای در/از % و تا % وارد کنید و مقدار افزایش را در فیلد گام % وارد کنید. به‌طور پیش‌فرض، اعلان‌ها در فواصل ۱۰٪ در محدوده مشخص‌شده ارسال می‌شوند.

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

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

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

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

1. به کادر گفتگوی اعلان‌ها دسترسی پیدا کنید.
2. در ستون «کنش‌ها» برای طرح نرخ، روی +اعلام کلیک کنید.
3. روی ویرایش کلیک کنید.
4. مقادیر را درصورت نیاز اصلاح کنید.
5. روی ذخیره اعلان کلیک کنید.

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

برای حذف کردن کنش و وضعیت اعلان:

1. به کادر گفتگوی اعلان‌ها دسترسی پیدا کنید.
2. در ستون «کنش‌ها» برای طرح نرخ، روی +اعلام کلیک کنید.
3. روی حذف اعلان کلیک کنید.

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

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

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

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

در زیر نمونه‌ای از نحوه ایجاد وضعیت اعلان ارائه شده است که وقتی درصد تعداد هدف تراکنش‌ها به ۸۰٪، ۹۰٪، ۱۰۰٪، ۱۱۰٪، و ۱۲۰٪ می‌رسد، وب‌قلابی را راه‌اندازی می‌کند.

{
    "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",
        }]
  }

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

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

کدهای پاسخ وب‌قلاب

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