रेट प्लान मैनेज करना

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

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

किराये के प्लान वाले पेज को एक्सप्लोर करना

किराया प्लान वाले पेज को ऐक्सेस करें. इसके लिए, यहां दिया गया तरीका अपनाएं.

किराये का प्लान बनाना

किराये का प्लान बनाने के लिए:

1. किराया प्लान पेज पर जाएं.
2. +किराया प्लान पर क्लिक करें.
3. सबसे ऊपर मौजूद पैनल में, इन फ़ील्ड को कॉन्फ़िगर करें:
   

   फ़ील्ड	ब्यौरा	डिफ़ॉल्ट	ज़रूरी है
   किराया प्लान का नाम	आपके रेट प्लान का नाम. NOTE: एपीआई प्रॉडक्ट बंडल में, नाम यूनीक होना चाहिए. एक ही प्रॉडक्ट बंडल में मौजूद दो प्लान के नाम एक जैसे नहीं हो सकते.	लागू नहीं	हां
   किराया प्लान का टाइप	किराया प्लान का टाइप. ड्रॉप-डाउन सूची से कोई वैल्यू चुनें. मान्य किराया प्लान के टाइप की सूची देखने के लिए, किराया प्लान के ऐसे टाइप जिनके साथ काम किया जा सकता है पर जाएं.	लागू नहीं	हां
   प्रॉडक्ट बंडल	एपीआई प्रॉडक्ट बंडल. ड्रॉप-डाउन सूची से कोई वैल्यू चुनें. एपीआई प्रॉडक्ट बंडल के बारे में ज़्यादा जानने के लिए, एपीआई प्रॉडक्ट बंडल मैनेज करना लेख पढ़ें. अगर आपने ऐसा प्रॉडक्ट बंडल चुना है जिसमें एक से ज़्यादा एपीआई प्रॉडक्ट शामिल हैं, तो आपको यह चुनना होगा कि हर एपीआई प्रॉडक्ट के लिए अलग-अलग किराया प्लान कॉन्फ़िगर करने हैं या एक सामान्य किराया प्लान कॉन्फ़िगर करना है, जो सभी एपीआई प्रॉडक्ट पर लागू होगा.	लागू नहीं	हां
   ऑडियंस	वह ऑडियंस जो रेट प्लान को ऐक्सेस कर सकती है. ड्रॉप-डाउन सूची से, इनमें से कोई एक वैल्यू चुनें: सभी - सभी डेवलपर. डेवलपर - डेवलपर या कंपनी. डेवलपर या कंपनी का नाम डालें. टाइप करते समय, डेवलपर/कंपनियों की एक सूची ड्रॉप-डाउन में दिखती है. इसमें वे डेवलपर/कंपनियां शामिल होती हैं जिनके नाम में वह स्ट्रिंग मौजूद होती है. ड्रॉप-डाउन सूची में, डेवलपर या कंपनी के नाम पर क्लिक करें. डेवलपर कैटगरी - डेवलपर कैटगरी. ड्रॉप-डाउन सूची से डेवलपर कैटगरी चुनें. डेवलपर कैटगरी मैनेज करना लेख में दिए गए निर्देशों के मुताबिक, डेवलपर कैटगरी को अपनी ज़रूरत के हिसाब से कॉन्फ़िगर करें.	सभी	नहीं
   शुरू होने की तारीख	किराया प्लान लागू होने की तारीख. शुरू होने की तारीख डालें या कैलेंडर का इस्तेमाल करके कोई तारीख चुनें.	आज	नहीं
   खत्म होने की तारीख	किराया प्लान खत्म होने की तारीख. खत्म होने की तारीख तय करने के लिए, खत्म होने की तारीख है टॉगल स्विच चालू करें. इसके बाद,खत्म होने की तारीख डालें या कैलेंडर का इस्तेमाल करके कोई तारीख चुनें. ध्यान दें: यह रेट प्लान, बताई गई तारीख को दिन के आखिर तक लागू रहेगा. उदाहरण के लिए, अगर आपको 1 दिसंबर, 2018 को किसी किराया प्लान की समयसीमा खत्म करनी है, तो endDate की वैल्यू 2018-11-30 पर सेट करें. इस मामले में, 30 नवंबर, 2018 को दिन के आखिर में रेट प्लान खत्म हो जाएगा. साथ ही, 1 दिसंबर, 2018 को किए गए सभी अनुरोध ब्लॉक कर दिए जाएंगे.	कोई नहीं	नहीं
   पोर्टल को दिखेगा	सेट करें कि किराया प्लान सार्वजनिक है या निजी. सार्वजनिक बनाम निजी दर वाले प्लान देखें.	चालू	नहीं

4. किराया प्लान के लिए शुल्क कॉन्फ़िगर करें. किराया प्लान के लिए शुल्क कॉन्फ़िगर करना लेख पढ़ें.
   NOTE: यह सुविधा, सूचनाओं के लिए तय किए गए प्लान पर लागू नहीं होती.
5. अगर आपने ऐसा प्रॉडक्ट बंडल चुना है जिसमें एक से ज़्यादा एपीआई प्रॉडक्ट शामिल हैं, तो खास या सामान्य दर योजना सेक्शन में जाकर, ये प्राथमिकताएं सेट करें:
   ध्यान दें: यह चरण, सूचनाओं की संख्या के हिसाब से तय होने वाली दर योजनाओं पर लागू नहीं होता.
   

   फ़ील्ड	ब्यौरा	डिफ़ॉल्ट
   हर प्रॉडक्ट को अलग-अलग कॉन्फ़िगर करना	यह फ़्लैग यह तय करता है कि हर एपीआई प्रॉडक्ट के लिए अलग-अलग दर वाला प्लान कॉन्फ़िगर करना है या नहीं.	बंद है
   हर प्रॉडक्ट के लिए, फ़्रीमिअम ऑफ़र को अलग-अलग कॉन्फ़िगर करना	यह फ़्लैग यह तय करता है कि हर एपीआई प्रॉडक्ट के लिए फ़्रीमिअम प्लान कॉन्फ़िगर करना है या नहीं.	बंद है
   प्रॉडक्ट चुनें	अगर आपने एक या दोनों फ़्लैग चालू किए हैं, तो आपको ड्रॉप-डाउन सूची से हर प्रॉडक्ट को अलग-अलग चुनना होगा. साथ ही, उसके रेट प्लान की जानकारी कॉन्फ़िगर करनी होगी. NOTE: पक्का करें कि आपने प्रॉडक्ट बंडल में मौजूद सभी प्रॉडक्ट कॉन्फ़िगर किए हों.	लागू नहीं

6. चुने गए रेट प्लान के टाइप के आधार पर, रेट प्लान की जानकारी कॉन्फ़िगर करें:
   
   • Freemium
   • रेट कार्ड
   • रेवेन्यू का बंटवारा
   • सूचना पाने की सेटिंग में बदलाव करने की सुविधा
7. इनमें से किसी एक पर क्लिक करें:
   

   बटन	ब्यौरा
   ड्राफ़्ट के तौर पर सेव करें	किराया प्लान को ड्राफ़्ट के तौर पर सेव करें. जब तक आपने दर योजना को पब्लिश नहीं किया है, तब तक यह ऐप्लिकेशन डेवलपर को नहीं दिखेगी. ड्राफ़्ट किए गए किसी भी रेट प्लान के किसी भी फ़ील्ड में बदलाव किया जा सकता है.
   नया प्लान पब्लिश करें	प्लान पब्लिश करें. NOTE: किराया प्लान पब्लिश करने के बाद, सिर्फ़ तब तक उसमें बदलाव किया जा सकता है, जब तक उसे सेट न किया गया हो. पब्लिश किए गए किसी भी किराया प्लान को मिटाया नहीं जा सकता. हालांकि, पब्लिश किए गए किसी किराया प्लान की समयसीमा खत्म करना लेख में बताए गए तरीके से, उस प्लान की समयसीमा खत्म की जा सकती है. साथ ही, उसे आने वाले समय के किसी किराया प्लान से बदला जा सकता है.

8. Monetization Limits Check नीति को, एपीआई प्रॉक्सी से अटैच करें. ये एपीआई प्रॉक्सी, रेट प्लान में शामिल एपीआई प्रॉडक्ट से जुड़ी होती हैं. 'कमाई करने की सीमाओं की जांच' नीति, एपीआई प्रॉक्सी पर कमाई करने की सीमाएं लागू करती है. साथ ही, यह पक्का करती है कि किसी भी गड़बड़ी को Analytics और कमाई करने से जुड़ी रिपोर्ट में सटीक तरीके से कैप्चर किया जाए. ज़्यादा जानकारी के लिए, एपीआई प्रॉक्सी पर कमाई करने की सीमाएं लागू करना लेख पढ़ें.

किराया प्लान में बदलाव करना

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

किराये के प्लान में बदलाव करने के लिए:

1. किराया प्लान पेज पर जाएं.
2. उस रेट प्लान की लाइन में क्लिक करें जिसमें आपको बदलाव करना है.
   किराया प्लान वाला पैनल दिखेगा.
3. ज़रूरत के मुताबिक, किराया प्लान के फ़ील्ड में बदलाव करें.
   NOTE: रेट प्लान पब्लिश करने के बाद, सिर्फ़ तब तक बदलाव किया जा सकता है, जब तक आपने प्लान खत्म होने की तारीख सेट न की हो.
4. इनमें से किसी एक पर क्लिक करें:

   बटन	ब्यौरा
   ड्राफ़्ट अपडेट करें (ड्राफ़्ट रेट प्लान)	किराया प्लान को ड्राफ़्ट के तौर पर सेव करें. जब तक आपने रेट प्लान पब्लिश नहीं किया है, तब तक यह ऐप्लिकेशन डेवलपर को नहीं दिखेगा. ड्राफ़्ट किए गए किसी भी रेट प्लान के किसी भी फ़ील्ड में बदलाव किया जा सकता है.
   ड्राफ़्ट पब्लिश करें (ड्राफ़्ट रेट प्लान)	किराया प्लान पब्लिश करें. NOTE: रेट प्लान पब्लिश करने के बाद, सिर्फ़ तब तक बदलाव किया जा सकता है, जब तक आपने प्लान खत्म होने की तारीख सेट न की हो. पब्लिश किए गए किसी भी किराया प्लान को मिटाया नहीं जा सकता. हालांकि, पब्लिश किए गए किसी किराया प्लान की समयसीमा खत्म करना लेख में बताए गए तरीके से, उस प्लान की समयसीमा खत्म की जा सकती है. साथ ही, उसे आने वाले समय के किसी किराया प्लान से बदला जा सकता है.
   अपडेट की गई समाप्ति तारीख (पब्लिश किए गए किराया प्लान)	पब्लिश किए गए प्लान के लिए खत्म होने की तारीख सेट करना. NOTE: पब्लिश किए गए रेट प्लान के लिए, खत्म होने की तारीख सेट करने के बाद, उसमें बदलाव नहीं किया जा सकता.

किराये के ड्राफ़्ट प्लान को मिटाना

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

ध्यान दें: पब्लिश किए गए रेट प्लान को मिटाया नहीं जा सकता.

ड्राफ़्ट किए गए किसी किराया प्लान को मिटाने के लिए:

1. किराया प्लान पेज पर जाएं.
2. ऐक्शन मेन्यू दिखाने के लिए, कर्सर को उस किराया प्लान पर रखें जिसे आपको मिटाना है.
3. पर क्लिक करें.
4. कार्रवाई की पुष्टि करने के लिए, मिटाएं पर क्लिक करें.

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

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

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

रेट प्लान बनाने के लिए, /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans पर POST अनुरोध जारी करें. यहां {monetizationpackage_id}, उस एपीआई प्रॉडक्ट बंडल का आईडी है जिसके लिए आपको रेट प्लान बनाना है. यह आईडी, एपीआई प्रॉडक्ट बंडल बनाते समय जवाब में मिलता है.

रेट प्लान बनाते समय, आपको अनुरोध के मुख्य हिस्से में यह जानकारी देनी होगी:

• संगठन आईडी
• एपीआई प्रॉडक्ट बंडल आईडी
• किराया प्लान का नाम
• किराया प्लान की जानकारी
• दर प्लान का दायरा (यह सभी डेवलपर पर लागू होता है या सिर्फ़ किसी खास डेवलपर, कंपनी या डेवलपर कैटगरी पर)
• वह तारीख जब किराया प्लान लागू होता है
• किराया प्लान के लिए मुद्रा
• रेट प्लान को पब्लिश करना है या नहीं
• किराया प्लान सार्वजनिक है या निजी

ऐसी अन्य सेटिंग भी हैं जिन्हें वैकल्पिक तौर पर सेट किया जा सकता है. जैसे, पेमेंट की समयसीमा (उदाहरण के लिए, 30 दिन). किराया प्लान के लिए कॉन्फ़िगरेशन प्रॉपर्टी देखें.

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

यहां दिए गए सेक्शन में, किराया प्लान बनाने का तरीका बताया गया है:

• एपीआई का इस्तेमाल करके स्टैंडर्ड रेट प्लान बनाना
• एपीआई का इस्तेमाल करके डेवलपर या कंपनी के लिए रेट प्लान बनाना
• एपीआई का इस्तेमाल करके, डेवलपर कैटगरी के लिए शुल्क वाला प्लान बनाना
• एपीआई का इस्तेमाल करके, एपीआई प्रॉडक्ट के लिए खास तौर पर तैयार किया गया रेट प्लान बनाना
• एपीआई का इस्तेमाल करके, किराये के प्लान को सार्वजनिक या निजी के तौर पर सेट करना

एपीआई का इस्तेमाल करके स्टैंडर्ड रेट प्लान बनाना

स्टैंडर्ड रेट प्लान बनाने के लिए, type एट्रिब्यूट की वैल्यू STANDARD पर सेट करें. इसका उदाहरण यहां दिया गया है.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

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

किसी डेवलपर या कंपनी पर रेट प्लान लागू करने के लिए, type वैल्यू को Developer पर सेट करें. आपको अनुरोध में डेवलपर या कंपनी की पहचान भी करनी होगी. इसके लिए, आपको डेवलपर या कंपनी का आईडी, कानूनी नाम, और नाम बताना होगा.

उदाहरण के लिए, यहां दिए गए अंश में Dev Five डेवलपर के लिए एक रेट प्लान बनाया गया है:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

एपीआई का इस्तेमाल करके, डेवलपर कैटगरी के लिए दर प्लान बनाना

रेट प्लान को डेवलपर कैटगरी पर लागू करने के लिए, type वैल्यू को Developer_Category पर सेट करें. आपको अनुरोध में डेवलपर कैटगरी की जानकारी भी देनी होगी. उदाहरण के लिए:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

एपीआई का इस्तेमाल करके, एपीआई प्रॉडक्ट के लिए खास तौर पर तैयार किया गया रेट प्लान बनाना

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

उदाहरण के लिए, यहां दिए गए कोड से दो एपीआई प्रॉडक्ट के साथ रेवेन्यू शेयर करने का प्लान बनाया जाता है:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

my-package एपीआई प्रॉडक्ट बंडल में एपीआई प्रॉडक्ट जोड़ने के लिए, आपको अनुरोध के मुख्य हिस्से में एपीआई प्रॉडक्ट के लिए, दर प्लान की जानकारी जोड़नी होगी. इसके बारे में एपीआई प्रॉडक्ट के लिए तय किए गए दर प्लान के साथ, एपीआई प्रॉडक्ट बंडल में एपीआई प्रॉडक्ट जोड़ना लेख में बताया गया है.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

एपीआई का इस्तेमाल करके, रेट प्लान को सार्वजनिक या निजी के तौर पर सेट करना

किराया प्लान बनाते समय, यह तय किया जा सकता है कि यह प्लान सार्वजनिक है या निजी. इसके लिए, अनुरोध के मुख्य हिस्से में isPrivate एट्रिब्यूट का इस्तेमाल करें. true पर सेट करने पर, किराया प्लान निजी होगा. ज़्यादा जानकारी के लिए, सार्वजनिक और निजी तौर पर उपलब्ध किराया प्लान देखें.

उदाहरण के लिए, यहां दिया गया कोड एक प्राइवेट रेट प्लान बनाता है:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

एपीआई का इस्तेमाल करके किराया प्लान पब्लिश करना

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

उदाहरण के लिए, यहां रेट कार्ड प्लान बनाया गया है और उसे पब्लिश किया गया है. हालांकि, अनुरोध का सिर्फ़ कुछ हिस्सा दिखाया गया है:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

एपीआई का इस्तेमाल करके, किराये के प्लान का ड्राफ़्ट सेव करना

रेट प्लान को पब्लिश किए बिना सेव करने के लिए, रेट प्लान बनाते समय published प्रॉपर्टी की वैल्यू को false पर सेट करें.

उदाहरण के लिए, यहां रेट कार्ड प्लान बनाया गया है और उसे ड्राफ़्ट के तौर पर सेव किया गया है. इसमें सिर्फ़ अनुरोध का कुछ हिस्सा दिखाया गया है:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

एपीआई का इस्तेमाल करके, किराये के प्लान के ड्राफ़्ट में बदलाव करना

रेट प्लान के ड्राफ़्ट को अपडेट करने के लिए, /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id} पर PUT अनुरोध भेजें. यहां {package_id}, एपीआई पैकेज की पहचान है और {plan_Id}, रेट प्लान की पहचान है. अपडेट करते समय, आपको अनुरोध के मुख्य हिस्से में अपडेट की गई सेटिंग और किराये की योजना का आईडी बताना होगा. अगर आपको रेट प्लान का किराया अपडेट करना है, तो आपको रेट प्लान के किराये का आईडी भी बताना होगा. उदाहरण के लिए, यहां दिया गया अनुरोध, उस रेट प्लान में रेट प्लान के रेट को अपडेट करता है जिसका आईडी location_flat_rate_card_plan है (अपडेट को हाइलाइट किया गया है):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "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/location_flat_rate_card_plan" \
-u email:password

जवाब में, अपडेट किए गए रेट प्लान का किराया शामिल है (जवाब का सिर्फ़ एक हिस्सा दिखाया गया है):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

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

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

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

एपीआई का इस्तेमाल करके, किसी संगठन के लिए सभी किराया प्लान देखना

किसी संगठन के सभी रेट प्लान देखने के लिए, /mint/organizations/{org_name}/rate-plans पर GET अनुरोध भेजें. यहां {org_name} आपके संगठन का नाम है.

नतीजों को फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास किए जा सकते हैं:

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

एपीआई का इस्तेमाल करके, एपीआई प्रॉडक्ट बंडल के सभी रेट प्लान देखना

किसी एपीआई पैकेज के सभी रेट प्लान देखने के लिए, /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans को जीईटी अनुरोध भेजें. यहां {package_id}, एपीआई पैकेज का आईडी है. पैकेज आईडी तब दिखता है, जब आपने कमाई करने के लिए पैकेज बनाया हो.

डिफ़ॉल्ट रूप से, नतीजों में सिर्फ़ चालू, सार्वजनिक, और स्टैंडर्ड रेट प्लान दिखाए जाते हैं. इसमें शामिल करने के लिए:

• ड्राफ़्ट या समयसीमा खत्म हो चुके किराया प्लान के लिए, current क्वेरी पैरामीटर को false पर सेट करें (उदाहरण के लिए, ?current=false).
• निजी दर वाले प्लान के लिए, showPrivate क्वेरी पैरामीटर को true पर सेट करें (उदाहरण के लिए, ?showPrivate=true).
• सभी स्टैंडर्ड रेट प्लान के लिए, standard क्वेरी पैरामीटर को true पर सेट करें (उदाहरण के लिए, ?standard=true).

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

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

किसी एपीआई पैकेज के लिए, दर प्लान देखने के लिए /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} पर जीईटी अनुरोध करें. यहां {package_id}, एपीआई पैकेज का आईडी है और {plan_id}, दर प्लान का आईडी है. पैकेज आईडी तब दिखता है, जब कमाई करने के लिए पैकेज बनाया जाता है. वहीं, दर प्लान का आईडी तब दिखता है, जब दर प्लान बनाया जाता है.

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

यहां जवाब का एक उदाहरण दिया गया है:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

एपीआई का इस्तेमाल करके, किसी डेवलपर के सभी चालू रेट प्लान देखना

किसी डेवलपर के सभी चालू रेट प्लान देखने के लिए, /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans पर GET अनुरोध करें. यहां {developer_id}, डेवलपर का ईमेल पता है.

नतीजों को फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास किए जा सकते हैं:

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

यहां जवाब का एक उदाहरण दिया गया है:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

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

किसी डेवलपर के लिए चालू रेट प्लान देखने के लिए, /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} पर GET अनुरोध जारी करें. यहां {developer_id} डेवलपर का ईमेल पता है और {developer_rateplan_id}, स्वीकार किए गए रेट प्लान का आईडी है. यह आईडी, पब्लिश किए गए रेट प्लान को स्वीकार करने पर जवाब में दिखता है.

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

यहां जवाब का एक उदाहरण दिया गया है:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

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

अगर आपको किसी ऐसे डेवलपर के लिए स्वीकार किया गया रेट प्लान देखना है जिसमें एपीआई प्रॉडक्ट शामिल है, तो /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product पर जीईटी अनुरोध करें. यहां {developer_id} डेवलपर का आईडी है और /{product_id} प्रॉडक्ट का आईडी है.

डिफ़ॉल्ट रूप से, नतीजों में सिर्फ़ सार्वजनिक तौर पर उपलब्ध किराया प्लान दिखाया जाता है. निजी दर योजना दिखाने के लिए, showPrivate क्वेरी पैरामीटर को true पर सेट करें. उदाहरण के लिए, ?showPrivate=true.

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

एपीआई का इस्तेमाल करके, डेवलपर के स्वीकार किए गए सभी रेट प्लान देखना

किसी डेवलपर ने जिन रेट प्लान को स्वीकार किया है उन्हें देखने के लिए, /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans पर GET अनुरोध भेजें. यहां {developer_id} डेवलपर का आईडी है.

नतीजों को फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास किए जा सकते हैं:

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

यहां जवाब का एक उदाहरण दिया गया है:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

एपीआई का इस्तेमाल करके, किराये की योजना का ड्राफ़्ट मिटाना

किराये के प्लान के ड्राफ़्ट को मिटाने के लिए, /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id} पर DELETE अनुरोध भेजें. यहां {plan_Id}, मिटाए जाने वाले किराये के प्लान का आइडेंटिफ़िकेशन है और {package_id}, किराये के प्लान के लिए एपीआई पैकेज का आइडेंटिफ़िकेशन है. जैसे:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

रेट प्लान के लिए कॉन्फ़िगरेशन प्रॉपर्टी

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

रेट प्लान की जानकारी के लिए कॉन्फ़िगरेशन प्रॉपर्टी

किराया प्लान बनाते समय, ratePlanDetails कलेक्शन के हिस्से के तौर पर, इनमें से किसी भी कॉन्फ़िगरेशन प्रॉपर्टी को तय किया जा सकता है.