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

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

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

कमाई करने की सुविधा से कई तरह के इवेंट के लिए सैंपल टेक्स्ट तय करने वाले टेंप्लेट का एक सेट मिलता है नोटिफ़िकेशन. इनमें से किसी भी टेंप्लेट को अपनी पसंद के मुताबिक बनाया जा सकता है, ताकि:

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

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

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

नीचे बताए गए तरीके से, सूचनाओं वाला पेज ऐक्सेस करें.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

किसी सूचना को चालू या बंद करना

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

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

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

एपीआई का इस्तेमाल करके टेंप्लेट की मदद से सूचनाएं पाने की सुविधा सेट अप की जा रही है

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

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

नीचे दिए गए सेक्शन में बताए गए तरीके से, एपीआई का इस्तेमाल करके सूचना टेंप्लेट मैनेज करें:

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

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

जीईटी जारी करके, कमाई करने से जुड़े सभी नोटिफ़िकेशन टेंप्लेट को लिस्ट किया जा सकता है /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

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

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

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

इसके लिए, 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"

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

के लिए एक PUT अनुरोध जारी करके एक सूचना टेम्प्लेट को संपादित करें /nint/organizations/{org_name}/notification-email-templates/{template_id}. अनुरोध के मुख्य हिस्से में, टेंप्लेट का बदला गया कॉन्टेंट उपलब्ध कराएं.

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

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

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 को एक पोस्ट अनुरोध भेजा गया.

अनुरोध करते समय, अनुरोध के मुख्य हिस्से में उस स्थिति के बारे में बताएं जो सूचना और शर्त पूरी होने पर की जाने वाली कार्रवाइयों की सूची देख सकता है. जैसे, सूचना ईमेल).

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

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

एपीआई का इस्तेमाल करके, सूचना से जुड़ी शर्त और कार्रवाई देखना

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

एपीआई का इस्तेमाल करके, सूचना की स्थिति और कार्रवाई में बदलाव करना

पोस्ट अनुरोध जारी करके, सूचना की स्थिति और कार्रवाई में बदलाव करें 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

एपीआई का इस्तेमाल करके, सूचना से जुड़ी शर्त और कार्रवाई को मिटाना

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

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

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

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

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

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

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

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