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

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

परिचय

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

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

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

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

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

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

कस्टम एट्रिब्यूट के हिसाब लगाने के तरीके को समझना

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

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

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

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

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

यहां हाई लेवल फ़्लो दिया गया है:

1. एपीआई प्रॉडक्ट जोड़ते समय, कस्टम एट्रिब्यूट तय करें.
2. API का ऐसा प्रॉडक्ट बंडल बनाएं जिसमें प्रॉडक्ट शामिल हो.
   एपीआई प्रॉडक्ट बंडल के लिए लेन-देन रिकॉर्ड करने की नीति में, वे कस्टम एट्रिब्यूट जोड़ें जिनका इस्तेमाल रेट प्लान तय करने के लिए किया जाएगा.
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>

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

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

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

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

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

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

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

ज़रूरी शर्तें पूरी करने के लिए, यह तरीका अपनाएं:

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

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

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

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

उदाहरण के लिए, यहां दिए गए कोड से, 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