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

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

परिचय

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

जवाब के हेडर में अनुरोध के पेलोड का साइज़ जोड़ना

हर मैसेज अनुरोध में, एक client.received.content.length वैरिएबल होता है. इसमें अनुरोध पेलोड में बाइट की संख्या होती है. Proxy Endpoint रिस्पॉन्स में Assign Message नीति जोड़कर, हम 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 नाम का कस्टम एट्रिब्यूट शामिल किया है, तो इस तरह:

Verify API Key नीति का इस्तेमाल करते समय (जो कमाई करने के लिए ज़रूरी है), यह वैल्यू verifyapikey.{policy_name}.apprating नाम के वैरिएबल में सेव की जाती है. Proxy Endpoint के रिस्पॉन्स से जुड़ी Assign Message नीति का इस्तेमाल करके, 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 यूज़र इंटरफ़ेस (यूआई) या Classic 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