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

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

परिचय

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

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

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

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

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

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

कस्टम एट्रिब्यूट कैलकुलेशन को समझना

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

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

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

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

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

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

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

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

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

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

मैसेज के हर अनुरोध में, एक 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. एपीआई प्रॉडक्ट और लेन-देन का डेटा रिकॉर्ड करने की नीतियों को ठीक वैसे ही कॉन्फ़िगर करने के बाद जैसे आपने चाहते हैं, तो एक API पैकेज बनाएँ जिसमें प्रॉडक्ट शामिल हो. एपीआई पैकेज बनाना देखें.

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

रेट प्लान बनाते समय, कस्टम एट्रिब्यूट का इस्तेमाल करके रेट प्लान की जानकारी दी जाती है. आपने लोगों तक पहुंचाया मुफ़्त में अनुरोध के मुख्य हिस्से में, 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