कस्टम एट्रिब्यूट की मदद से रेट प्लान कॉन्फ़िगर करें

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

शुरुआती जानकारी

कुछ मामलों में, आपको वैरिएबल या कस्टम वैल्यू पर आधारित ट्रांज़ैक्शन काउंटर की ज़रूरत पड़ सकती है. उदाहरण के लिए, आपको ये काम करने पड़ सकते हैं:

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

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

कस्टम एट्रिब्यूट वाले इन रेट प्लान का इस्तेमाल किया जा सकता है:

• कस्टम एट्रिब्यूट वाला रेट कार्ड
• कस्टम एट्रिब्यूट वाली सूचना में बदलाव करने की सुविधा

एक रेट प्लान के लिए, ज़्यादा से ज़्यादा 10 कस्टम एट्रिब्यूट सेट किए जा सकते हैं.

कस्टम एट्रिब्यूट की गिनती के बारे में जानकारी

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

चार्जिंग मॉडल	कस्टम एट्रिब्यूट की गिनती करना
समान दर और वॉल्यूम बैंडेड	custom attribute number * rate = charge to developer एक समान दर के लिए, कस्टम एट्रिब्यूट संख्या, ऐसे लेन-देन की संख्या बन जाती है जिन्हें दर से गुणा किया जाता है. वॉल्यूम बैंडेड के लिए, किसी बैंड में ट्रांज़ैक्शन की संख्या को कस्टम एट्रिब्यूट की संख्या के हिसाब से बढ़ा दिया जाता है. साथ ही, उस ट्रांज़ैक्शन की संख्या के लिए डेवलपर शुल्क लिया जाता है. उदाहरण के लिए, अगर मैसेज में कस्टम एट्रिब्यूट की वैल्यू 10 है, तो डेवलपर से 10 लेन-देन का शुल्क लिया जाएगा और मौजूदा बैंड की संख्या में 10 लेन-देन जोड़ दिए जाते हैं. अगर डेवलपर के मौजूदा बैंड में सिर्फ़ छह ट्रांज़ैक्शन बचे थे, तो 6 को उस बैंड की दर से गुणा किया जाता है. बाकी चार अगले बैंड में जाते हैं और उस बैंड की दर से गुणा किए जाते हैं. वॉल्यूम बैंडेड प्लान में, अगर आखिरी वॉल्यूम बैंड की कोई सीमा ("अनलिमिटेड" नहीं है) और उस सीमा से ज़्यादा लेन-देन होता है, तो दो चीज़ें होती हैं: डेवलपर को "ज़्यादा" रकम बिना किसी शुल्क के मिलती है. डेवलपर ऐप्लिकेशन को, प्लान की अवधि रीसेट होने तक एपीआई का इस्तेमाल करने की अनुमति नहीं मिलती. प्लान रीसेट कब किए जाते हैं, इसकी जानकारी के लिए बार-बार लगने वाले शुल्क कब और बंडल प्लान रीसेट किए जाते हैं? देखें.
Bundles	बंडल का शुल्क ग्रुप के हिसाब से लिया जाता है, लेन-देन के हिसाब से नहीं. इसलिए, इस तरह का हिसाब लगाया जाता है: custom attribute number = amount added to bundle count उदाहरण के लिए, अगर मैसेज में कस्टम एट्रिब्यूट की संख्या 10 है, तो बंडल में इस्तेमाल किए गए ट्रांज़ैक्शन की संख्या में 10 जोड़ दिया जाता है. अगर डेवलपर के मौजूदा बंडल में सिर्फ़ छह ट्रांज़ैक्शन बचे थे, तो उस बंडल को भरा जाता है और अगले बंडल की संख्या चार बढ़ जाती है. अगले बंडल के लिए तय की गई दर से शुल्क लिया जाएगा. अगर आखिरी बंडल की कोई सीमा ("असीमित" नहीं है) और कोई लेन-देन उस सीमा से ज़्यादा है, तो दो चीज़ें होंगी: डेवलपर को "ज़्यादा" रकम बिना किसी शुल्क के मिलती है. डेवलपर ऐप्लिकेशन को, प्लान की अवधि रीसेट होने तक एपीआई का इस्तेमाल करने की अनुमति नहीं मिलती. प्लान रीसेट कब किए जाते हैं, इसकी जानकारी के लिए बार-बार लगने वाले शुल्क कब और बंडल प्लान रीसेट किए जाते हैं? देखें.
अडजस्ट की जा सकने वाली सूचनाएं	अडजस्ट की जा सकने वाली सूचनाओं के लिए, ये कैलकुलेशन किए जाते हैं: custom attribute number = amount added to transaction count उदाहरण के लिए, अगर मैसेज में कस्टम एट्रिब्यूट की संख्या 10 है, तो ट्रांज़ैक्शन की कुल संख्या में 10 जोड़ दिया जाता है.

रेट प्लान को कस्टम एट्रिब्यूट की वैल्यू कहां मिलती है

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

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

यहां बताया गया हाई-लेवल फ़्लो:

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

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

मैसेज में कस्टम एट्रिब्यूट की वैल्यू जनरेट करने का तरीका

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

रिस्पॉन्स हेडर में, अनुरोध वाले पेलोड के साइज़ को जोड़ा जा रहा है

मैसेज के हर अनुरोध में, एक client.received.content.length वैरिएबल होता है. इसमें अनुरोध के पेलोड में मौजूद बाइट की संख्या शामिल होती है. प्रॉक्सी एंडपॉइंट रिस्पॉन्स में 'मैसेज असाइन करें' नीति से अटैच करके, हम messageSize नाम का रिस्पॉन्स हेडर जनरेट कर सकते हैं. इसमें लंबाई वाली वैल्यू होती है:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

ऐप्लिकेशन के हेडर में कस्टम एट्रिब्यूट की वैल्यू जोड़ना

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

'एपीआई पासकोड की पुष्टि करें' नीति (कमाई करने के लिए ज़रूरी है) का इस्तेमाल करते समय, इस वैल्यू को verifyapikey.{policy_name}.apprating नाम के वैरिएबल में सेव किया जाता है. प्रॉक्सी एंडपॉइंट रिस्पॉन्स से अटैच मैसेज नीति असाइन करने का इस्तेमाल करके, apprating नाम का एक हेडर जनरेट किया जा सकता है. इस हेडर में ऐप्लिकेशन की apprating वैल्यू शामिल होती है:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

रेट प्लान सेट अप करना

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

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

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

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

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

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

इन ज़रूरी शर्तों को पूरा करें:

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

इसके बाद, रेट प्लान बनाने के लिए एपीआई का इस्तेमाल किया जाता है.

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

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

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

यहां, messageSize नाम के कस्टम एट्रिब्यूट के आधार पर, कस्टम एट्रिब्यूट रेट प्लान के साथ बदलाव करने लायक सूचना बनाई गई है. आइटम को बोल्ड में देखें.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based 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": "messageSize",
           "ratingParameterUnit": "MB",
           "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