नोटिफ़िकेशन टेंप्लेट का इस्तेमाल करके, सूचनाएं सेट अप करना

आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी

सूचना के टेंप्लेट क्या होते हैं?

मौद्रीकरण की सुविधा, टेंप्लेट का एक सेट उपलब्ध कराती है. इसमें अलग-अलग तरह के इवेंट की सूचनाओं के लिए सैंपल टेक्स्ट दिया गया है. इनमें से किसी भी टेंप्लेट को अपनी पसंद के मुताबिक बनाया जा सकता है, ताकि:

• सभी डेवलपर को इवेंट के बारे में सूचना दें. जैसे, नए प्रॉडक्ट, शर्तों के नए वर्शन या नए रेट प्लान.
• जिन डेवलपर पर असर पड़ा है उन्हें इवेंट के बारे में सूचना दें. जैसे, दर प्लान में बदलाव.
• एपीआई उपलब्ध कराने वाली कंपनी को डेवलपर से जुड़े इवेंट के बारे में सूचना देना. जैसे, जब कोई डेवलपर किसी खाते के लिए रजिस्टर करता है या जब कोई डेवलपर किसी रेट प्लान के लिए साइन अप करता है.
• कंपनी के सभी एडमिन को किसी इवेंट के बारे में सूचना दें.

इसके अलावा, एक ऐसा वेबहुक बनाया जा सकता है जो एचटीटीपी कॉलबैक हैंडलर तय करता है. इसके बाद, वेबहुक को ट्रिगर करने वाली शर्त को कॉन्फ़िगर किया जा सकता है. इसके बारे में वेबहुक का इस्तेमाल करके सूचनाएं सेट अप करना लेख में बताया गया है.

सूचनाएं पेज को एक्सप्लोर करना

सूचनाएं पेज को ऐक्सेस करें. इसके लिए, यहां दिया गया तरीका अपनाएं.

सूचनाओं में बदलाव करना

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके किसी सूचना में बदलाव करने के लिए:

1. सूचनाएं पेज पर जाएं.
2. जिस सूचना में बदलाव करना है उसके बगल में मौजूद पर क्लिक करके, उसकी जानकारी देखें.
3. ज़रूरत के मुताबिक, विषय, मुख्य भाग, और पाने वाले (अगर उपलब्ध हो) फ़ील्ड में बदलाव करें.

   सूचना के टेंप्लेट में तय किए जा सकने वाले वैरिएबल के बारे में जानने के लिए, सूचना के टेंप्लेट में वैरिएबल का इस्तेमाल करना लेख पढ़ें.

   हर कैटगरी में सूचनाओं में बदलाव करने के बारे में ज़्यादा जानने के लिए, यहां दिए गए सेक्शन देखें:

   • सभी डेवलपर को सूचना देने के लिए सूचनाओं में बदलाव करना
   • सूचनाओं में बदलाव करके, उन डेवलपर को सूचना देना जिन पर असर पड़ा है
   • एपीआई सेवा देने वाली कंपनियों को सूचना देने के लिए सूचनाओं में बदलाव करना
4. सूचना पाने की सुविधा चालू करने के लिए, उसके बगल में मौजूद चेक बॉक्स को चुनें.
5. अन्य सूचनाओं में बदलाव करने के लिए, दूसरे से चौथे चरण तक की प्रोसेस दोहराएं.
6. सभी बदलावों को सेव करने के लिए, सेव करें पर क्लिक करें.

आपको एक मैसेज दिखेगा. इससे पुष्टि होगी कि सूचनाएं सेव कर ली गई हैं. सेव करने में कुछ मिनट लग सकते हैं.

सभी डेवलपर को सूचना देने के लिए, सूचनाओं में बदलाव करना

सभी डेवलपर को सूचना दें सेक्शन में चुने गए इवेंट के टाइप की सूचनाएं, सभी डेवलपर को भेजी जाती हैं.

सूचनाओं को दिन के आखिर में भेजने के लिए शेड्यूल किया गया है. सूचनाएं भेजे जाने के बाद, इवेंट के चेकबॉक्स अपने-आप हट जाते हैं. इनसे जुड़े इवेंट टाइप के लिए सूचनाएं शेड्यूल करने के लिए, आपको इन्हें फिर से चुनना होगा.

यहां दी गई टेबल में, 'सभी डेवलपर को सूचना दें' सेक्शन में मौजूद इवेंट टाइप के आधार पर सूचनाओं की सूची दी गई है. ज़्यादा जानकारी के लिए, यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके सूचनाओं में बदलाव करना लेख पढ़ें.

सूचनाओं में बदलाव करके, उन डेवलपर को सूचना देना जिन पर असर पड़ा है

उन डेवलपर को सूचना दें सेक्शन में चुने गए इवेंट के टाइप की सूचनाएं, सिर्फ़ उन डेवलपर को भेजी जाती हैं जिन पर उन इवेंट का असर पड़ा है. उदाहरण के लिए, अगर आपने संशोधित किए गए रेट प्लान वाला इवेंट चुना है, तो सूचना सिर्फ़ उन डेवलपर को भेजी जाएगी जिन्होंने रेट प्लान स्वीकार किया है.

यहां दी गई टेबल में, 'उन डेवलपर को सूचना दें जिन पर असर पड़ा है' सेक्शन में, इवेंट टाइप के आधार पर सूचनाएं दी गई हैं. ज़्यादा जानकारी के लिए, यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके सूचनाओं में बदलाव करना लेख पढ़ें.

एपीआई की सेवा देने वाली कंपनियों को सूचना देने के लिए सूचनाओं में बदलाव करना

एपीआई सेवा देने वाली कंपनी को सूचना दें सेक्शन में चुने गए इवेंट के टाइप की सूचनाएं, एपीआई सेवा देने वाली उस कंपनी को भेजी जाती हैं जिसे आपने चुना है.

नीचे दी गई टेबल में, Notify API Provider सेक्शन में मौजूद इवेंट टाइप के आधार पर सूचनाएं दी गई हैं. ज़्यादा जानकारी के लिए, यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके सूचनाओं में बदलाव करना लेख पढ़ें.

सूचना पाने की सुविधा चालू या बंद करना

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, सूचना को चालू या बंद करने के लिए:

1. सूचनाएं पेज पर जाएं.
2. सूचना के बगल में मौजूद चेक बॉक्स को चुनकर या उससे चुने हुए का निशान हटाकर, सूचना को चालू या बंद करें.
3. सभी बदलावों को सेव करने के लिए, सेव करें पर क्लिक करें.

सेव करने में कुछ मिनट लग सकते हैं. आपको एक मैसेज दिखेगा. इससे पुष्टि होगी कि सूचनाएं सेव कर ली गई हैं.

एपीआई का इस्तेमाल करके, टेंप्लेट की मदद से सूचनाएं सेट अप करना

एपीआई का इस्तेमाल करके सूचनाएं सेट अप करें. इसके बारे में यहां बताया गया है.

एपीआई का इस्तेमाल करके सूचना के टेंप्लेट मैनेज करना

एपीआई का इस्तेमाल करके सूचना के टेंप्लेट मैनेज करें. इसके बारे में यहां बताया गया है:

• एपीआई का इस्तेमाल करके, सूचना के सभी टेंप्लेट देखना
• एपीआई का इस्तेमाल करके सूचना के टेंप्लेट को देखना
• एपीआई का इस्तेमाल करके सूचना के टेंप्लेट में बदलाव करना

एपीआई का इस्तेमाल करके, सूचना के सभी टेंप्लेट देखना

मुद्रीकरण की सुविधा देने वाले सभी सूचना टेंप्लेट की सूची बनाने के लिए, /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
}

API का इस्तेमाल करके सूचना का टेंप्लेट देखना

/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 अनुरोध भेजकर, सूचना के किसी टेंप्लेट में बदलाव करें. अनुरोध के मुख्य हिस्से में, टेंप्लेट का बदला हुआ कॉन्टेंट दें.

सूचना के टेंप्लेट में मैसेज को पसंद के मुताबिक बनाते समय, एक या उससे ज़्यादा वैरिएबल शामिल किए जा सकते हैं. ज़्यादा जानकारी के लिए, सूचना के टेंप्लेट में वैरिएबल का इस्तेमाल करना लेख पढ़ें.

उदाहरण के लिए, यहां दिए गए अनुरोध में, एपीआई प्रॉडक्ट की नई सूचना के कॉन्टेंट में बदलाव किया गया है:

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

एपीआई का इस्तेमाल करके, सूचना पाने की शर्तें और कार्रवाइयां मैनेज करना

एपीआई का इस्तेमाल करके, सूचना पाने की शर्तों और कार्रवाइयों को मैनेज करें. इसके बारे में यहां बताया गया है.

• एपीआई का इस्तेमाल करके सूचना की शर्त और कार्रवाई तय करना
• एपीआई का इस्तेमाल करके, सूचना की शर्त और कार्रवाई देखना
• एपीआई का इस्तेमाल करके, सूचना पाने की शर्त और कार्रवाई में बदलाव करना
• एपीआई का इस्तेमाल करके, सूचना पाने की शर्त और कार्रवाई को मिटाना

एपीआई का इस्तेमाल करके, सूचना भेजने की शर्त और कार्रवाई तय करना

सूचना की ऐसी शर्त और कार्रवाई बनाएं जिससे /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

सूचना की शर्तों के लिए कॉन्फ़िगरेशन प्रॉपर्टी

एपीआई का इस्तेमाल करते समय, सूचना की शर्तों के लिए कॉन्फ़िगरेशन की ये प्रॉपर्टी उपलब्ध होती हैं.

सूचना से जुड़ी कार्रवाइयों के लिए कॉन्फ़िगरेशन प्रॉपर्टी

API का इस्तेमाल करते समय, सूचना से जुड़ी कार्रवाइयों के लिए ये कॉन्फ़िगरेशन प्रॉपर्टी उपलब्ध होती हैं.

सूचना के टेंप्लेट में वैरिएबल का इस्तेमाल करना

सूचना टेंप्लेट में मैसेज में बदलाव करते समय, एक या उससे ज़्यादा वैरिएबल शामिल किए जा सकते हैं. इसके लिए, Spring Expression Language (SpEL) का इस्तेमाल करें. इससे लेन-देन ऑब्जेक्ट में दिखाई गई वैल्यू को दिखाया जा सकता है.

यहां दी गई टेबल में, सूचना के टेंप्लेट के सबसे ज़्यादा इस्तेमाल किए जाने वाले वैरिएबल की खास जानकारी दी गई है.

जवाब देने के लिए तय किए गए ईमेल पते को अपनी पसंद के मुताबिक बनाना

मुद्रीकरण के लिए, noreply@apigee.com का डिफ़ॉल्ट पता कॉन्फ़िगर किया जाता है. इसका इस्तेमाल, कंपनियों और डेवलपर को भेजे जाने वाले ईमेल सूचनाओं के लिए किया जाता है. अपने संगठन के लिए जवाब देने वाले का नाम और पता कॉन्फ़िगर करने के लिए, Apigee की सहायता टीम से संपर्क करें.