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

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

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

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

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

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

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

नीचे बताए गए तरीके के मुताबिक, सूचना पेज को ऐक्सेस करें.

Edge

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

  1. apigee.com/edge में साइन इन करें.
  2. बाएं नेविगेशन बार में, पब्लिश करें > कमाई करना > सूचनाएं चुनें.

इसके बाद, सूचनाएं पेज दिखेगा.

जैसा कि इस डायग्राम में दिखाया गया है, सूचनाएं पेज की मदद से ये काम किए जा सकते हैं:

क्लासिक एज (प्राइवेट क्लाउड)

क्लासिक Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके 'सूचनाएं' पेज को ऐक्सेस करने के लिए:

  1. http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.

  2. सबसे ऊपर मौजूद नेविगेशन बार में, एडमिन > सूचनाएं चुनें.

सूचनाएं पेज की मदद से ये काम किए जा सकते हैं:

सूचनाएं संपादित की जा रही हैं

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

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

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

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

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

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

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

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

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

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

इवेंट टाइप ट्रिगर ज़रूरी जानकारी
नया पैकेज नया एपीआई पैकेज उपलब्ध है

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

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

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

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

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

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

इवेंट टाइप ट्रिगर ज़रूरी जानकारी
नियम और शर्तें स्वीकार नहीं की गईं या उनकी समयसीमा खत्म हो गई नियमों और शर्तों का नया सेट पब्लिश कर दिया गया है और डेवलपर ने उन्हें अब तक स्वीकार नहीं किया है

यह सूचना, नए नियम और शर्तें लागू होने से 30 दिन, 7 दिन, और 1 दिन पहले भेजी जाती है.
नया रेट प्लान नए रेट प्लान पब्लिश किए गए हैं

अगर रेट प्लान:

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

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

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

डेवलपर को बताएं कि लागू शुल्क लिया जाएगा.
दर की सीमा पार हो गई है रेट प्लान की तय सीमा पार हो गई है

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

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

डेवलपर के लिए बिलिंग के दस्तावेज़ (जैसे कि इनवॉइस) उपलब्ध हैं.
डेवलपर, किराया तय करने के नए प्लान के लिए साइन अप करता है डेवलपर, किराया तय करने के नए प्लान के लिए साइन अप करता है.

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

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

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

इवेंट टाइप ट्रिगर
नए डेवलपर के लिए साइन अप

डेवलपर ने खाते के लिए रजिस्टर किया है.
डेवलपर एक ऐप्लिकेशन जोड़ता है

डेवलपर ने एक नई ऐप्लिकेशन बनाई है.
रेट के लिए नए प्लान के लिए डेवलपर साइन अप करें

डेवलपर ने रेट प्लान के लिए साइन अप किया है.
डेवलपर ने वित्तीय जानकारी में बदलाव किया

डेवलपर ने अपनी कंपनी का नाम या कंपनी का पता जैसी वित्तीय जानकारी बदल दी है.

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

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

  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
}

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

/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 पर पोस्ट अनुरोध जारी करके, सूचना से जुड़ी ऐसी शर्त और कार्रवाई बनाएं जिससे अपने-आप सूचना मिले.

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

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

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} पर जीईटी अनुरोध जारी करें. यहां {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

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

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

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

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

नाम ब्यौरा डिफ़ॉल्ट ज़रूरी है?
attribute

सूचना की स्थिति के बारे में जानकारी. सूचना की स्थिति को बेहतर बनाने के लिए, एक या उससे ज़्यादा एट्रिब्यूट तय किए जा सकते हैं.

वैल्यू इनमें से एक या इससे ज़्यादा हो सकती है:

  • ADD_RATEPLAN
  • ADHOC_NOTIFY_DEVELOPERS
  • BILLING_DOCS_PUBLISHED
  • COMPANY_ACCEPTS_INVITATION
  • COMPANY_CANCELS_INVITATION
  • COMPANY_DECLINES_INVITATION
  • COMPANY_INVITES_DEVELOPER
  • CREATE_APPLICATION
  • CREATE_DEVELOPER
  • DATE
  • DEVELOPER_ACCEPTS_INVITATION
  • DEVELOPER_CANCELS_INVITATION
  • DEVELOPER_DECLINES_INVITATION
  • DEVELOPER_INVITES_COMPANY
  • EXPIRING_TNC
  • FeeExposure
  • FREEMIUM_USED_UP
  • NEW_PACKAGE
  • NEW_PRODUCT
  • PUBLISHED
  • RATEPLAN
  • RATEPLAN_ACCEPTED
  • RATEPLAN_ENDED
  • RATEPLAN_EXPIRED
  • RATEPLAN_RENEWED
  • RATEPLAN_REVISION
  • Transactions
  • UPDATE_DEVELOPER
  • UsageTarget (सिर्फ़ वेबहुक कॉन्फ़िगर करने के लिए मान्य)
 लागू नहीं हां
value

एट्रिब्यूट की वैल्यू.

 लागू नहीं नहीं
associatedCondition

किसी संबंधित शर्त का रेफ़रंस.

 लागू नहीं नहीं

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

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

नाम ब्यौरा डिफ़ॉल्ट ज़रूरी है?
actionAttribute

सूचना पाने वाले की पहचान करने के लिए इस्तेमाल किया गया तरीका. वैल्यू इनमें से एक या इससे ज़्यादा हो सकती है:

  • ORG_EMAIL. सूचना पाने वाले की पहचान ईमेल पते से की जाती है.
  • DEV_ID. सूचना पाने वाले की पहचान, डेवलपर आईडी (ईमेल पते) से की जाती है.
  • COMPANY_ADMINS. वैल्यू सेट करने पर ध्यान दिए बिना, कंपनी के सभी एडमिन को सूचना भेजी जाती है. ध्यान रखें कि कंपनी के एडमिन, संगठन के एडमिन से अलग होते हैं.
  • WEBHOOK. सूचना पाने वाले की जानकारी, वेबहुक कॉलबैक हैंडलर को भेजी जाती है. वेबहुक का इस्तेमाल करके सूचनाएं सेट अप करना देखें.
 लागू नहीं हां
value

कार्रवाई एट्रिब्यूट की वैल्यू.

अगर actionAttribute को ORG_EMAIL या DEV_ID पर सेट किया जाता है, तो ANY वैल्यू ऐसे किसी भी व्यक्ति को सूचना भेजती है जिसे यह सुविधा मिल सकती है. उदाहरण के लिए, कोई भी ORG_EMAIL पता या कोई DEV_ID.

अगर actionAttribute को WEBHOOK पर सेट किया गया है, तो इस वैल्यू को वेबहुक के आईडी पर सेट करें.

अगर actionAttribute को COMPANY_ADMINS पर सेट किया जाता है, तो इस वैल्यू को अनदेखा कर दिया जाता है. इसकी सूचना कंपनी के सभी एडमिन को भेजी जाती है.

 लागू नहीं हां
templateID

सूचना के टेंप्लेट का आईडी.

ध्यान दें: अगर actionAttribute को WEBHOOK पर सेट किया गया है, तो यह विकल्प मान्य नहीं होगा.

 लागू नहीं हां
postURL

वेबहुक के लिए कॉलबैक हैंडलर.

ध्यान दें: अगर actionAttribute को WEBHOOK पर सेट किया गया है, तो यह विकल्प ज़रूरी है. अगर वैल्यू को ORG_EMAIL, DEV_ID या COMPANY_ADMINS पर सेट किया गया है, तो यह विकल्प मान्य नहीं है.

 लागू नहीं हां

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

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

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

वैरिएबल ब्यौरा
${application.name}

किसी ऐप्लिकेशन का नाम.
${application.products.name} ऐप्लिकेशन में शामिल प्रॉडक्ट का नाम.
${BALANCE} दिए गए कोटा के लिए बैलेंस.
${developer.legalName}

डेवलपर की कंपनी का नाम.
${developer.name}

डेवलपर का नाम.
${EXPIRY_DATE}

वह तारीख या समय जब सीमा खत्म हो जाती है या वह रीसेट हो जाती है.
${LONG_PERCENT} मौजूदा इस्तेमाल के हिसाब से सीमा का प्रतिशत. इसमें % चिह्न नहीं है. उदाहरण के लिए, 50
${PERCENT}

उस सीमा का प्रतिशत जिस तक मौजूदा इस्तेमाल के हिसाब से डेटा इस्तेमाल किया जा रहा है. यह % सिंबल के साथ है. उदाहरण के लिए, 50%.
${products.displayName} किसी प्रॉडक्ट के लिए तय किया गया डिसप्ले नेम.
${QUOTA_TYPE}

सीमा का टाइप (लेन-देन की संख्या, खर्च की सीमा या शुल्क का एक्सपोज़र).
${QUOTA_UNIT}

सीमा के लिए बुनियादी इकाई: मुद्रा (खर्च सीमा के लिए) या कॉल (लेन-देन की सीमा के लिए).
${QUOTA_LIMIT}

किसी सीमा की रकम.
${ratePlan.displayName} रेट प्लान के लिए तय किया गया डिसप्ले नेम.
${ratePlan.endDate} वह तारीख जब एपीआई की सेवा देने वाली कंपनी ने रेट प्लान खत्म किया.
${ratePlan.monetizationPackage.displayName}

एपीआई पैकेज का नाम.
${ratePlan.monetizationPackage.name} कमाई करने की सुविधा देने वाले पैकेज का नाम.
${ratePlan.monetizationPackage.products.displayName}

एपीआई प्रॉडक्ट के लिए तय किया गया डिसप्ले नेम.
${ratePlan.monetizationPackage.products.name} कमाई करने की सुविधा देने वाले पैकेज में शामिल प्रॉडक्ट का नाम.
${ratePlan.startDate} वह तारीख जब रेट प्लान बनाया गया था.
${USAGE} मौजूदा इस्तेमाल (कुल रेवेन्यू या शुल्क या वॉल्यूम).
${USER}

उपयोगकर्ता का नाम.

अपना जवाब देने वाले ईमेल पते को कस्टमाइज़ करना

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