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

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

الگوهای اعلان چیست؟

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

• به همه برنامه‌نویسان درباره رویدادهایی مانند محصولات جدید، نسخه‌های جدید T&C یا طرح‌های نرخ جدید اطلاع دهید.
• به برنامه‌نویسان متاثر از رویدادهایی مانند طرح نرخ اصلاح‌شده اطلاع دهید.
• در مورد رویدادهای مرتبط با برنامه‌نویس، مانند زمانی که یک توسعه‌دهنده برای یک حساب ثبت نام می‌کند یا زمانی که یک توسعه‌دهنده برای یک طرح نرخ ثبت‌نام می‌کند، به ارائه‌دهنده API اطلاع دهید.
• همه مدیران شرکت را در مورد یک رویداد خاص مطلع کنید.

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

کاوش در صفحه اعلان ها

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

در حال ویرایش اعلان ها

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

1. به صفحه اعلان ها دسترسی پیدا کنید.
2. کلیک کنید در مجاورت اعلانی که می خواهید ویرایش کنید تا جزئیات آن را گسترش دهید.
3. فیلدهای موضوع، متن و گیرنده (در صورت وجود) را در صورت لزوم ویرایش کنید.

   برای اطلاعات در مورد متغیرهایی که می توان در یک الگوی اعلان مشخص کرد، به استفاده از متغیرها در الگوهای اعلان مراجعه کنید.

   برای اطلاعات بیشتر در مورد ویرایش اعلان‌ها در هر دسته به بخش‌های زیر مراجعه کنید:

   • ویرایش اعلان‌ها برای اطلاع به همه توسعه‌دهندگان
   • ویرایش اعلان‌ها برای اطلاع از برنامه‌نویسان متاثر
   • ویرایش اعلان‌ها برای Notify API Providers
4. یک اعلان را با انتخاب کادر کناری آن فعال کنید.
5. مراحل 2 تا 4 را برای ویرایش اعلان‌های اضافی تکرار کنید.
6. برای ذخیره همه تغییرات روی ذخیره کلیک کنید.

پیامی برای تایید ذخیره شدن اعلان ها نمایش داده می شود. عملیات ذخیره ممکن است چند دقیقه طول بکشد.

ویرایش اعلان‌ها برای اطلاع به همه توسعه‌دهندگان

اعلان‌ها برای انواع رویدادهایی که در بخش Notify All Developers انتخاب می‌کنید برای همه توسعه‌دهندگان ارسال می‌شود.

اعلان‌ها قرار است در پایان روز اجرا شوند. پس از ارسال اعلان ها، چک باکس های رویداد به طور خودکار پاک می شوند. برای برنامه‌ریزی اعلان‌ها برای انواع رویداد مرتبط، باید آنها را دوباره انتخاب کنید.

جدول زیر اعلان‌ها را بر اساس انواع رویداد در بخش Notify All Developers فهرست می‌کند. برای اطلاعات بیشتر، به ویرایش اعلان‌ها با استفاده از رابط کاربری مراجعه کنید.

ویرایش اعلان‌ها برای اطلاع از برنامه‌نویسان متاثر

اعلان‌های مربوط به انواع رویدادهایی که در بخش Notify Affected Developers انتخاب می‌کنید فقط برای توسعه‌دهندگانی ارسال می‌شود که تحت تأثیر آن نوع رویدادها قرار گرفته‌اند. به عنوان مثال، اگر رویداد طرح نرخ اصلاح شده را انتخاب کنید، یک اعلان فقط برای توسعه دهندگانی ارسال می شود که طرح نرخ را پذیرفته اند.

جدول زیر اعلان‌ها را بر اساس انواع رویداد در بخش Notify Affected Developers فهرست می‌کند. برای اطلاعات بیشتر، به ویرایش اعلان‌ها با استفاده از رابط کاربری مراجعه کنید.

ویرایش اعلان‌ها برای Notify API Providers

اعلان‌ها برای انواع رویدادهایی که در بخش Notify API Provider انتخاب می‌کنید به ارائه‌دهنده API که شما مشخص کرده‌اید ارسال می‌شود.

جدول زیر اعلان‌ها را بر اساس انواع رویداد در بخش Notify API Provider فهرست می‌کند. برای اطلاعات بیشتر، به ویرایش اعلان‌ها با استفاده از رابط کاربری مراجعه کنید.

فعال یا غیرفعال کردن اعلان

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

1. به صفحه اعلان ها دسترسی پیدا کنید.
2. یک اعلان را با انتخاب یا غیرفعال کردن به ترتیب تیک کادر مجاور آن، فعال یا غیرفعال کنید.
3. برای ذخیره همه تغییرات روی ذخیره کلیک کنید.

عملیات ذخیره ممکن است چند دقیقه طول بکشد. پیامی برای تایید ذخیره شدن اعلان ها نمایش داده می شود.

تنظیم اعلان ها با استفاده از الگوها با استفاده از API

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

مدیریت الگوهای اعلان با استفاده از API

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

• مشاهده تمام الگوهای اعلان با استفاده از API
• مشاهده یک الگوی اعلان با استفاده از API
• ویرایش یک الگوی اعلان با استفاده از API

مشاهده تمام الگوهای اعلان با استفاده از API

می‌توانید با ارسال یک درخواست GET به /mint/organizations/{org_name}/notification-email-templates تمام الگوهای اعلان‌هایی را که کسب درآمد ارائه می‌کند فهرست کنید. به عنوان مثال:

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

برای مثال، شکل زیر یک الگوی رویداد است که توسعه‌دهندگان را از در دسترس بودن یک محصول API جدید مطلع می‌کند:

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

مشاهده یک الگوی اعلان با استفاده از API

با ارسال یک درخواست GET به /mint/organizations/{org_name}/notification-email-templates/{template_id} یک الگوی اعلان را مشاهده کنید، جایی که {template_id} شناسه الگو است. به عنوان مثال:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

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

• ${developer.legalName}.XYZ company
• ${developer.name}.DEV1
• ${QUOTA_TYPE}.Transactions
• ${PERCENT}.90%
• ${QUOTA_UNIT}.Calls
• ${QUOTA_LIMIT}.100
• ${ratePlan.monetizationPackage.products.name}.X
• ${EXPIRY_DATE}.2016-09-30

پیام اعلان ارائه شده توسط الگو این خواهد بود:

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

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

با ارسال یک درخواست PUT به /nint/organizations/{org_name}/notification-email-templates/{template_id} یک الگوی اعلان را ویرایش کنید. محتوای تغییر یافته الگو را در بدنه درخواست ارائه دهید.

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

برای مثال، درخواست زیر محتوای یک اعلان محصول API جدید را ویرایش می‌کند:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

مدیریت شرایط و اقدامات اعلان با استفاده از API

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

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

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

با ارسال یک درخواست POST به /mint/organizations/{org_name}/notification-conditions یک شرایط اعلان و اقدامی ایجاد کنید که منجر به اعلان خودکار شود.

هنگامی که درخواست را انجام می دهید، در بدنه درخواست، شرایطی را که منجر به اعلان می شود و اقداماتی که باید در هنگام رسیدن به شرایط انجام شود (مانند ارسال ایمیل اعلان) مشخص کنید.

شما جزئیات شرایط اعلان را با تعیین یک یا چند مقدار مشخصه تعریف می کنید. برای شرایط اعلان برای لیستی از ویژگی ها به ویژگی های پیکربندی مراجعه کنید. برای اعلان رویداد، ممکن است هنگام انتشار یک محصول جدید، این شرایط فعال شود.

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

برای مثال، درخواست زیر مشخص می‌کند که وقتی ویژگی NEW_PRODUCT است و مقدار مشخصه PUBLISHED true است، اعلان موجود در الگو را با شناسه 01191bf9-5fdd-45bf-8130-3f024694e63 ارسال کنید (این DEFAULT_NEW_PRODUCT_TEMPLATE است).

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

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

با ارسال یک درخواست GET به organizations/{org_name}/notification-conditions/{condition_Id} شرایط و اقدام اعلان را مشاهده کنید، جایی که {condition_Id} شناسه شرط است. زمانی که شرایط اعلان را ایجاد می کنید، شناسه برگردانده می شود. به عنوان مثال:

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

در زیر نمونه ای از پاسخ ارائه شده است:

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

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

با ارسال یک درخواست POST به organizations/{org_name}/notification-conditions/{condition_Id} که {condition_Id} شناسه شرط است، شرایط و اقدام اعلان را ویرایش کنید. زمانی که شرایط اعلان را ایجاد می کنید، شناسه برگردانده می شود. هنگامی که درخواست را صادر می کنید، تغییراتی را که می خواهید در شرایط یا عملکرد اعلان ایجاد کنید، در بدنه درخواست مشخص کنید.

به عنوان مثال:

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

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

با ارسال یک درخواست DELETE به organizations/{org_name}notification-conditions/{condition_Id} یک شرط اعلان را حذف کنید. به عنوان مثال:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

ویژگی های پیکربندی برای شرایط اعلان

ویژگی های پیکربندی زیر برای شرایط اعلان هنگام استفاده از API در دسترس است.

ویژگی های پیکربندی برای اقدامات اعلان

ویژگی‌های پیکربندی زیر برای اقدامات اعلان هنگام استفاده از API در دسترس هستند.

استفاده از متغیرها در الگوهای اعلان

وقتی پیام را در یک الگوی اعلان ویرایش می‌کنید، می‌توانید یک یا چند متغیر را با استفاده از زبان بیان بهار (SpEL) اضافه کنید تا مقادیر بازگردانده شده در شی Transaction را نشان دهید.

جدول زیر متداول ترین متغیرهای الگوی اعلان را خلاصه می کند.