বিজ্ঞপ্তি টেমপ্লেট ব্যবহার করে বিজ্ঞপ্তি সেট আপ করুন

আপনি Apigee Edge-এর ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন .info- তে যান।

নোটিফিকেশন টেমপ্লেট বলতে কী বোঝায়?

মনিটাইজেশন বিভিন্ন ধরণের ইভেন্ট নোটিফিকেশনের জন্য নমুনা টেক্সট নির্ধারণকারী কিছু টেমপ্লেট প্রদান করে। আপনি এই টেমপ্লেটগুলোর যেকোনোটি কাস্টমাইজ করতে পারেন:

• নতুন পণ্য, শর্তাবলীর নতুন সংস্করণ বা নতুন মূল্য পরিকল্পনার মতো ঘটনা সম্পর্কে সকল ডেভেলপারকে অবহিত করুন।
• সংশোধিত মূল্য পরিকল্পনার মতো ঘটনা সম্পর্কে প্রভাবিত ডেভেলপারদের অবহিত করুন।
• কোনো ডেভেলপার যখন অ্যাকাউন্টের জন্য নিবন্ধন করেন বা কোনো রেট প্ল্যানের জন্য সাইন আপ করেন, তখন ডেভেলপার-সম্পর্কিত ইভেন্টগুলো সম্পর্কে এপিআই প্রোভাইডারকে অবহিত করুন।
• একটি নির্দিষ্ট ঘটনা সম্পর্কে কোম্পানির সকল প্রশাসককে অবহিত করুন।

বিকল্পভাবে, আপনি একটি ওয়েবহুক তৈরি করতে পারেন যা একটি HTTP কলব্যাক হ্যান্ডলার সংজ্ঞায়িত করে, তারপর ওয়েবহুকটি ট্রিগার করার শর্তটি কনফিগার করতে পারেন, যেমনটি "ওয়েবহুক ব্যবহার করে নোটিফিকেশন সেট আপ করুন" অংশে বর্ণনা করা হয়েছে।

নোটিফিকেশন পৃষ্ঠাটি অন্বেষণ করা

নীচে বর্ণিত পদ্ধতি অনুসারে নোটিফিকেশন পেজটি অ্যাক্সেস করুন।

বিজ্ঞপ্তি সম্পাদনা

UI ব্যবহার করে একটি নোটিফিকেশন সম্পাদনা করতে:

1. নোটিফিকেশন পেজটি অ্যাক্সেস করুন।
2. ক্লিক করুন যে নোটিফিকেশনটির বিবরণ আপনি সম্পাদনা করে বিস্তারিত দেখতে চান, সেটির পাশে থাকা বাটনটিতে ক্লিক করুন।
3. প্রয়োজন অনুযায়ী বিষয়, মূল অংশ এবং প্রাপক (যদি থাকে) ক্ষেত্রগুলো সম্পাদনা করুন।

   নোটিফিকেশন টেমপ্লেটের মধ্যে যে ভেরিয়েবলগুলো নির্দিষ্ট করা যায়, সে সম্পর্কে জানতে “নোটিফিকেশন টেমপ্লেটে ভেরিয়েবল ব্যবহার” দেখুন।

   প্রতিটি বিভাগে বিজ্ঞপ্তি সম্পাদনা সম্পর্কে আরও তথ্যের জন্য নিম্নলিখিত বিভাগগুলি দেখুন:

   • সকল ডেভেলপারকে অবহিত করার জন্য বিজ্ঞপ্তি সম্পাদনা করা
   • প্রভাবিত ডেভেলপারদের অবহিত করার জন্য বিজ্ঞপ্তি সম্পাদনা করা
   • এপিআই প্রোভাইডারদের অবহিত করতে নোটিফিকেশন সম্পাদনা করা
4. এর পাশের চেকবক্সটি নির্বাচন করে নোটিফিকেশনটি সক্রিয় করুন।
5. অতিরিক্ত নোটিফিকেশন সম্পাদনা করতে ২ থেকে ৪ নম্বর ধাপগুলো পুনরাবৃত্তি করুন।
6. সমস্ত পরিবর্তন সংরক্ষণ করতে সেভ-এ ক্লিক করুন।

নোটিফিকেশনগুলো সংরক্ষণ করা হয়েছে তা নিশ্চিত করতে একটি বার্তা প্রদর্শিত হয়। সংরক্ষণ প্রক্রিয়াটিতে কয়েক মিনিট সময় লাগতে পারে।

সকল ডেভেলপারকে অবহিত করার জন্য বিজ্ঞপ্তি সম্পাদনা করা

'সকল ডেভেলপারকে অবহিত করুন' বিভাগে আপনি যে ধরনের ইভেন্ট নির্বাচন করেন, সেগুলোর নোটিফিকেশন সকল ডেভেলপারের কাছে পাঠানো হয়।

নোটিফিকেশনগুলো দিনের শেষে চালানোর জন্য নির্ধারিত করা আছে। নোটিফিকেশনগুলো পাঠানোর পর, ইভেন্টের চেকবক্সগুলো স্বয়ংক্রিয়ভাবে খালি হয়ে যায়। সংশ্লিষ্ট ইভেন্টের ধরনগুলোর জন্য নোটিফিকেশন নির্ধারণ করতে আপনাকে অবশ্যই সেগুলো আবার নির্বাচন করতে হবে।

নিম্নলিখিত সারণিতে 'সকল ডেভেলপারকে অবহিত করুন' বিভাগের ইভেন্টের প্রকারভেদের উপর ভিত্তি করে বিজ্ঞপ্তিগুলি তালিকাভুক্ত করা হয়েছে। আরও তথ্যের জন্য, 'ইউআই ব্যবহার করে বিজ্ঞপ্তি সম্পাদনা' দেখুন।

প্রভাবিত ডেভেলপারদের অবহিত করার জন্য বিজ্ঞপ্তি সম্পাদনা করা

'প্রভাবিত ডেভেলপারদের অবহিত করুন' বিভাগে আপনি যে ধরনের ইভেন্ট নির্বাচন করেন, সেই ধরনের ইভেন্টের জন্য বিজ্ঞপ্তি শুধুমাত্র সেইসব ডেভেলপারদের কাছেই পাঠানো হয় যারা সেই ইভেন্ট দ্বারা প্রভাবিত। উদাহরণস্বরূপ, আপনি যদি 'সংশোধিত রেট প্ল্যান' ইভেন্টটি নির্বাচন করেন, তাহলে একটি বিজ্ঞপ্তি শুধুমাত্র সেইসব ডেভেলপারদের কাছে পাঠানো হবে যারা রেট প্ল্যানটি গ্রহণ করেছেন।

নিম্নলিখিত সারণিতে 'প্রভাবিত ডেভেলপারদের অবহিত করুন' বিভাগের ইভেন্টের প্রকার অনুসারে বিজ্ঞপ্তিগুলি তালিকাভুক্ত করা হয়েছে। আরও তথ্যের জন্য, 'ইউআই ব্যবহার করে বিজ্ঞপ্তি সম্পাদনা' দেখুন।

এপিআই প্রোভাইডারদের অবহিত করতে নোটিফিকেশন সম্পাদনা করা

'নোটিফাই এপিআই প্রোভাইডার' বিভাগে আপনি যে ধরনের ইভেন্ট নির্বাচন করেন, সেগুলোর নোটিফিকেশন আপনার নির্দিষ্ট করা এপিআই প্রোভাইডারের কাছে পাঠানো হয়।

নিম্নলিখিত সারণিতে ‘নোটিফাই এপিআই প্রোভাইডার’ বিভাগে ইভেন্টের প্রকারভেদের উপর ভিত্তি করে নোটিফিকেশনগুলো তালিকাভুক্ত করা হয়েছে। আরও তথ্যের জন্য, ‘ইউআই ব্যবহার করে নোটিফিকেশন সম্পাদনা’ দেখুন।

একটি বিজ্ঞপ্তি সক্রিয় বা নিষ্ক্রিয় করা

UI ব্যবহার করে কোনো নোটিফিকেশন চালু বা বন্ধ করতে:

1. নোটিফিকেশন পেজটি অ্যাক্সেস করুন।
2. কোনো নোটিফিকেশনের পাশের চেকবক্সটি যথাক্রমে নির্বাচন বা অনির্বাচন করে সেটি চালু বা বন্ধ করুন।
3. সমস্ত পরিবর্তন সংরক্ষণ করতে সেভ-এ ক্লিক করুন।

সংরক্ষণ প্রক্রিয়াটি সম্পন্ন হতে কয়েক মিনিট সময় লাগতে পারে। নোটিফিকেশনগুলো সংরক্ষিত হয়েছে তা নিশ্চিত করতে একটি বার্তা প্রদর্শিত হয়।

এপিআই ব্যবহার করে টেমপ্লেটের মাধ্যমে নোটিফিকেশন সেট আপ করা

নিম্নলিখিত বিভাগগুলিতে বর্ণিত পদ্ধতি অনুসারে এপিআই (API) ব্যবহার করে নোটিফিকেশন সেট আপ করুন।

এপিআই ব্যবহার করে নোটিফিকেশন টেমপ্লেট পরিচালনা করা

নিম্নলিখিত বিভাগগুলিতে বর্ণিত পদ্ধতি অনুসারে এপিআই (API) ব্যবহার করে নোটিফিকেশন টেমপ্লেটগুলি পরিচালনা করুন:

• এপিআই ব্যবহার করে সমস্ত নোটিফিকেশন টেমপ্লেট দেখা
• এপিআই ব্যবহার করে একটি নোটিফিকেশন টেমপ্লেট দেখা
• এপিআই ব্যবহার করে একটি নোটিফিকেশন টেমপ্লেট সম্পাদনা করা

এপিআই ব্যবহার করে সমস্ত নোটিফিকেশন টেমপ্লেট দেখা

/mint/organizations/{org_name}/notification-email-templates একটি GET অনুরোধ পাঠিয়ে আপনি মনিটাইজেশন দ্বারা প্রদত্ত সমস্ত নোটিফিকেশন টেমপ্লেটের তালিকা দেখতে পারেন। উদাহরণস্বরূপ:

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

উদাহরণস্বরূপ, নিম্নলিখিতটি একটি ইভেন্ট টেমপ্লেট যা ডেভেলপারদের একটি নতুন এপিআই পণ্যের উপলব্ধতা সম্পর্কে অবহিত করে:

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

এপিআই ব্যবহার করে একটি নোটিফিকেশন টেমপ্লেট দেখা

/mint/organizations/{org_name}/notification-email-templates/{template_id} -এ একটি GET অনুরোধ পাঠিয়ে একটি নোটিফিকেশন টেমপ্লেট দেখুন, যেখানে {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"

এপিআই ব্যবহার করে একটি নোটিফিকেশন টেমপ্লেট সম্পাদনা করা

/nint/organizations/{org_name}/notification-email-templates/{template_id} -এ একটি PUT অনুরোধ পাঠিয়ে একটি নোটিফিকেশন টেমপ্লেট সম্পাদনা করুন। অনুরোধের বডিতে টেমপ্লেটের পরিবর্তিত বিষয়বস্তু প্রদান করুন।

নোটিফিকেশন টেমপ্লেটে মেসেজ কাস্টমাইজ করার সময়, আপনি এক বা একাধিক ভ্যারিয়েবল অন্তর্ভুক্ত করতে পারেন। আরও তথ্যের জন্য, নোটিফিকেশন টেমপ্লেটে ভ্যারিয়েবলের ব্যবহার দেখুন।

উদাহরণস্বরূপ, নিম্নলিখিত অনুরোধটি একটি নতুন 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 ব্যবহার করে নোটিফিকেশনের শর্তাবলী এবং অ্যাকশনগুলি পরিচালনা করুন।

• এপিআই ব্যবহার করে নোটিফিকেশন কন্ডিশন এবং অ্যাকশন তৈরি করা
• এপিআই ব্যবহার করে একটি নোটিফিকেশনের শর্ত এবং অ্যাকশন দেখা
• এপিআই ব্যবহার করে নোটিফিকেশনের শর্ত ও অ্যাকশন সম্পাদনা করা
• এপিআই ব্যবহার করে একটি নোটিফিকেশন কন্ডিশন এবং অ্যাকশন মুছে ফেলা

এপিআই ব্যবহার করে নোটিফিকেশন কন্ডিশন এবং অ্যাকশন তৈরি করা

/mint/organizations/{org_name}/notification-conditions একটি POST অনুরোধ পাঠিয়ে একটি নোটিফিকেশন শর্ত এবং অ্যাকশন তৈরি করুন, যার ফলে একটি স্বয়ংক্রিয় নোটিফিকেশন পাঠানো হবে।

অনুরোধ করার সময়, অনুরোধের মূল অংশে সেই শর্তটি উল্লেখ করুন যার ফলে নোটিফিকেশনটি পাঠানো হবে, এবং শর্তটি পূরণ হলে কী পদক্ষেপ নেওয়া হবে (যেমন একটি নোটিফিকেশন ইমেল পাঠানো)।

আপনি এক বা একাধিক অ্যাট্রিবিউট ভ্যালু উল্লেখ করে নোটিফিকেশন কন্ডিশনের বিস্তারিত বিবরণ নির্ধারণ করেন। অ্যাট্রিবিউটগুলোর তালিকার জন্য নোটিফিকেশন কন্ডিশনের কনফিগারেশন প্রোপার্টিজ দেখুন। একটি ইভেন্ট নোটিফিকেশনের ক্ষেত্রে, নতুন কোনো প্রোডাক্ট প্রকাশিত হলে কন্ডিশনটি ট্রিগার হতে পারে।

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

এপিআই ব্যবহার করে একটি নোটিফিকেশনের শর্ত এবং অ্যাকশন দেখা

একটি নোটিফিকেশন কন্ডিশন এবং অ্যাকশন দেখতে organizations/{org_name}/notification-conditions/{condition_Id} -এ একটি GET রিকোয়েস্ট পাঠান, যেখানে {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"
    } ]
    }

এপিআই ব্যবহার করে নোটিফিকেশনের শর্ত ও অ্যাকশন সম্পাদনা করা

একটি নোটিফিকেশন কন্ডিশন এবং অ্যাকশন সম্পাদনা করতে organizations/{org_name}/notification-conditions/{condition_Id} -এ একটি POST রিকোয়েস্ট পাঠান, যেখানে {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

এপিআই ব্যবহার করে একটি নোটিফিকেশন কন্ডিশন এবং অ্যাকশন মুছে ফেলা

organizations/{org_name}notification-conditions/{condition_Id} -এ একটি DELETE অনুরোধ জারি করে একটি নোটিফিকেশন শর্ত মুছে ফেলুন। উদাহরণস্বরূপ:

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

বিজ্ঞপ্তির শর্তাবলীর জন্য কনফিগারেশন বৈশিষ্ট্য

এপিআই ব্যবহার করার সময় নোটিফিকেশন শর্তাবলীর জন্য নিম্নলিখিত কনফিগারেশন প্রোপার্টিগুলো উপলব্ধ থাকে।

বিজ্ঞপ্তি কার্যক্রমের জন্য কনফিগারেশন বৈশিষ্ট্য

এপিআই ব্যবহার করার সময় নোটিফিকেশন অ্যাকশনের জন্য নিম্নলিখিত কনফিগারেশন প্রোপার্টিগুলো উপলব্ধ থাকে।

নোটিফিকেশন টেমপ্লেটে ভেরিয়েবল ব্যবহার করা

যখন আপনি একটি নোটিফিকেশন টেমপ্লেটে মেসেজ এডিট করেন, তখন ট্রানজ্যাকশন অবজেক্টে ফেরত আসা ভ্যালুগুলো উপস্থাপন করার জন্য আপনি স্প্রিং এক্সপ্রেশন ল্যাঙ্গুয়েজ (SpEL) ব্যবহার করে এক বা একাধিক ভ্যারিয়েবল অন্তর্ভুক্ত করতে পারেন।

নিম্নলিখিত সারণিতে সর্বাধিক ব্যবহৃত নোটিফিকেশন টেমপ্লেট ভেরিয়েবলগুলোর সারসংক্ষেপ দেওয়া হলো।