अडजस्ट किए जा सकने वाले नोटिफ़िकेशन प्लान को कॉन्फ़िगर करें

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

परिचय

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

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, सूचनाओं के लिए अडजस्ट किए जा सकने वाले प्लान को कॉन्फ़िगर करना

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

Edge

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

फ़ील्ड ब्यौरा डिफ़ॉल्ट
कैलकुलेशन की फ़्रीक्वेंसी वह समयावधि जिस दौरान लेन-देन की संख्या (या कस्टम एट्रिब्यूट से जुड़ी संख्या) का हिसाब लगाया जाता है. महीनों की संख्या चुनें (1 से 24 महीने). 1 महीना

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

उदाहरण के लिए, आपको:

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

ज़्यादा जानकारी के लिए, कस्टम एट्रिब्यूट के साथ रेट प्लान को कॉन्फ़िगर करना देखें.

क्लासिक Edge (निजी क्लाउड)

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

  1. किराया प्लान की विंडो में, प्लान की जानकारी वाले टैब पर, किराया प्लान का टाइप फ़ील्ड में सूचना में बदलाव करें चुनें.

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

  2. रिन्यूअल की अवधि वाले फ़ील्ड को उन महीनों की संख्या पर सेट करें जब प्लान अपने-आप रिन्यू हो जाएगा. ऐसा तब तक होगा, जब तक डेवलपर उस तारीख से पहले समझौते को खत्म नहीं कर देता. अगर इस वैल्यू को 0 पर सेट किया जाता है, तो प्लान तब तक लागू रहता है, जब तक डेवलपर उसे खत्म नहीं कर देता.
  3. सामान्य किराया प्लान में जाकर, जानकारी पर क्लिक करें.
  4. उस समयावधि के लिए एग्रीगेशन के आधार को सेट करें जिसमें ट्रांज़ैक्शन की संख्या एग्रीगेट की गई है. 1 से 24 महीने के बीच की कोई संख्या चुनें. यह वैल्यू डिफ़ॉल्ट रूप से एक महीने पर सेट होती है.
  5. लागू करें और बंद करें पर क्लिक करें.
  6. ड्राफ़्ट सेव करें पर क्लिक करें.
  7. प्लान को सिर्फ़ तब पब्लिश करें, जब आपको पूरी तरह से यकीन हो कि तैयार हो जाएगा. पब्लिश करने की तारीख सेट करने और प्लान पब्लिश करने के बारे में जानने के लिए, पब्लिश करने की दर से जुड़े प्लान देखें.

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

एपीआई का इस्तेमाल करके, सूचनाओं के लिए अडजस्ट किए जा सकने वाले प्लान को कॉन्फ़िगर करना

/organizations/{org_name}/monetization-packages/{package_id}/rate-plans पर किए जाने वाले पोस्ट अनुरोध के अनुरोध बॉडी में, ratePlanDetails प्रॉपर्टी में, सूचना के लिए बनाए गए उस प्लान की जानकारी दें जिसे बदला जा सकता है.

अडजस्ट होने वाला नोटिफ़िकेशन प्लान तय करने के लिए, अनुरोध के मुख्य हिस्से के pricePlanDetails में, ये वैल्यू बताएं:

प्रॉपर्टी वैल्यू
type USAGE_TARGET पर सेट करें.
meteringType DEV_SPECIFIC पर सेट करें.
duration durationType के साथ, एग्रीगेशन के आधार के लिए समयावधि सेट करें. सूचना की दर में बदलाव करने की सुविधा वाले प्लान के लिए, इसे 1 से 24 के बीच की कोई पूर्णांक वैल्यू पर सेट करें.
durationType

एग्रीगेशन के आधार के लिए, समयावधि के साथ-साथ durationType पर सेट करें. सूचना की दर में बदलाव करने की सुविधा वाले प्लान के लिए, इस वैल्यू को MONTH पर सेट करें.

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

उदाहरण के लिए, यहां एक ऐसा सूचना प्लान बताया गया है जिसे अडजस्ट किया जा सकता है. इसमें डेटा इकट्ठा करने का आधार, एक महीने पर सेट है.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

एपीआई का इस्तेमाल करके हर ऐप्लिकेशन डेवलपर के लिए, लेन-देन की टारगेट संख्या सेट करना

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

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

रेट प्लान स्वीकार करते समय, लेन-देन की टारगेट संख्या सेट करना

रेट प्लान स्वीकार करते समय, लेन-देन की टारगेट संख्या सेट करने के लिए, /organizations/{org_name}/developers/{developer_id}/developer-rateplans संसाधन को किए गए पोस्ट अनुरोध में, अनुरोध के मुख्य हिस्से में quotaTarget प्रॉपर्टी के बारे में बताएं. ऐप्लिकेशन डेवलपर से सूचनाएं पाने की सुविधा बंद करने के लिए, quotaTarget को पॉज़िटिव इंटीजर या 0 पर सेट करें. अगर कोई वैल्यू नहीं दी जाती है, तो quotaTarget की डिफ़ॉल्ट वैल्यू 0 होती है.

उदाहरण के लिए, जब ऐप्लिकेशन डेवलपर, सूचना के लिए अडजस्ट किए जा सकने वाले प्लान को स्वीकार करता है, तो नीचे दिए गए अनुरोध से लेन-देन की टारगेट संख्या 4,000 पर सेट हो जाती है.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

स्वीकार किए जाने वाले रेट प्लान को अपडेट करते समय, लेन-देन की टारगेट संख्या सेट करना

लेन-देन की टारगेट संख्या सेट करने के लिए, स्वीकार किए गए किराये के प्लान को अपडेट किया जा सकता है. साथ ही, /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} रिसोर्स के लिए पुट अनुरोध में, अनुरोध के मुख्य हिस्से में quotaTarget प्रॉपर्टी की जानकारी दी जा सकती है. ऐप्लिकेशन डेवलपर के लिए सूचनाएं पाने की सुविधा बंद करने के लिए, quotaTarget को किसी पूर्णांक या 0 पर सेट करें. अगर इसके बारे में नहीं बताया गया है, तो quotaTarget की डिफ़ॉल्ट वैल्यू 0 हो जाती है.

पब्लिश की गई दर का प्लान स्वीकार करने पर, जवाब में {developer_rateplan_id} दिखता है.

उदाहरण के लिए:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

इसके अलावा, /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans पर GET अनुरोध भेजकर, डेवलपर के लिए तय किए गए किराये के प्लान का {developer-rateplan-id} भी पाया जा सकता है. यहां {developer_id}, डेवलपर का ईमेल पता है. ज़्यादा जानकारी के लिए, डेवलपर के स्वीकार किए गए सभी किराये के प्लान देखना लेख पढ़ें.

उदाहरण के लिए:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

इस अनुरोध में, लेन-देन की टारगेट संख्या को 4,000 पर अपडेट किया गया है.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password