एपीआई प्रॉडक्ट बंडल मैनेज करना

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

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

एपीआई प्रॉडक्ट बंडल क्या है?

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

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

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

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

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

'प्रॉडक्ट बंडल' पेज के बारे में जानकारी

'प्रॉडक्ट बंडल' पेज को ऐक्सेस करने का तरीका यहां बताया गया है.

प्रॉडक्ट बंडल जोड़ना

एपीआई प्रॉडक्ट बंडल जोड़ने के लिए:

1. 'प्रॉडक्ट बंडल पेज' पर, + एपीआई प्रॉडक्ट बंडल पर क्लिक करें.
2. एपीआई प्रॉडक्ट बंडल के लिए कोई नाम डालें.

3. 'कोई प्रॉडक्ट जोड़ें' फ़ील्ड में, किसी एपीआई प्रॉडक्ट का नाम डालें.

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

4. अन्य एपीआई प्रॉडक्ट के नाम जोड़ने के लिए, चरण 3 दोहराएं.
5. जोड़े गए हर एपीआई प्रॉडक्ट के लिए, लेन-देन रिकॉर्ड करने की नीति कॉन्फ़िगर करें.
6. प्रॉडक्ट बंडल सेव करें पर क्लिक करें.

प्रॉडक्ट बंडल में बदलाव करना

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

1. 'प्रॉडक्ट बंडल' पेज पर, उस प्रॉडक्ट बंडल की लाइन में कहीं भी क्लिक करें जिसमें बदलाव करना है.

   प्रॉडक्ट बंडल पैनल दिखता है.

2. ज़रूरत के मुताबिक, प्रॉडक्ट बंडल के फ़ील्ड में बदलाव करें.

   ज़्यादा जानकारी के लिए, लेन-देन रिकॉर्ड करने की नीति कॉन्फ़िगर करना लेख देखें.

3. प्रॉडक्ट बंडल अपडेट करें पर क्लिक करें.

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

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

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

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

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

आपके पास संगठन तय करने का विकल्प होता है.

एपीआई को दिखने वाले विकल्पों की सूची के लिए, एपीआई प्रॉडक्ट बंडल के कॉन्फ़िगरेशन की प्रॉपर्टी देखें.

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "description": "payment messaging package",
     "displayName": "Payment Messaging Package",
     "name": "Payment Messaging Package",
     "organization": { "id": "{org_name}" },
     "product": [
       { "id": "messaging" },
       { "id": "payment" }
     ],
     "status": "CREATED"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password

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

{
   "description" : "payment messaging package",
   "displayName" : "Payment Messaging Package",
   "id" : "payment_messaging_package",
   "name" : "Payment Messaging Package",
   "organization" : {
     "id" : "{org_name}",
     "separateInvoiceForFees" : false
   },
   "product" : [ {
     "customAtt1Name" : "user",
     "description" : "Messaging",
     "displayName" : "Messaging",
     "id" : "messaging",
     "name" : "messaging",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }, {
     "customAtt1Name" : "user",
     "description" : "Payment",
     "displayName" : "Payment",
     "id" : "payment",
     "name" : "payment",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }],
   "status" : "CREATED"
 }

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

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

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

एपीआई प्रॉडक्ट बंडल में एपीआई प्रॉडक्ट जोड़ना

किसी एपीआई प्रॉडक्ट को एपीआई प्रॉडक्ट बंडल में जोड़ने के लिए, POST अनुरोध भेजें organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, यहां {org_name} आपकी कंपनी का नाम, {package_id} एपीआई प्रॉडक्ट बंडल का नाम, और {product_id} एपीआई प्रॉडक्ट का आईडी है.

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

$ curl -H "Accept:application/json" -X POST -d \
'{}'\
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

एपीआई प्रॉडक्ट बंडल में, एपीआई प्रॉडक्ट-खास रेट प्लान के साथ एपीआई प्रॉडक्ट जोड़ना

किसी एपीआई प्रॉडक्ट को ऐसे एपीआई प्रॉडक्ट बंडल में जोड़ने के लिए, जिसमें एपीआई प्रॉडक्ट-खास एक या उससे ज़्यादा रेट प्लान तय किए गए हैं (रेट कार्ड या रेवेन्यू शेयर), organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} पर POST अनुरोध भेजें. यहां {org_name} आपकी कंपनी का नाम, {package_id} एपीआई प्रॉडक्ट बंडल का नाम, और {product_id} एपीआई प्रॉडक्ट का आईडी है.

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

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [ 
        {
            "id": "mypackage_rateplan1",
            "ratePlanDetails": [
                {
                    "currency": {
                        "id": "usd"
                    },
                    "duration": 1,
                    "durationType": "MONTH",
                    "meteringType": "UNIT",
                    "organization" : {
                        "id": "{org_name}",
                    "paymentDueDays": "30",
                    "ratePlanRates": [
                        {
                            "rate": "1.99",
                            "startUnit": "0",
                            "type": "RATECARD"
                        }
                    ],
                    "ratingParameter": "VOLUME",
                    "type": "RATECARD"
                }
            ]
        }
    ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

एपीआई प्रॉडक्ट बंडल से एपीआई प्रॉडक्ट मिटाना

किसी एपीआई प्रॉडक्ट को एपीआई प्रॉडक्ट बंडल से मिटाने के लिए, organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, पर DELETE अनुरोध भेजें. यहां {org_name} आपकी कंपनी का नाम, {package_id} एपीआई प्रॉडक्ट बंडल का नाम, और {product_id} एपीआई प्रॉडक्ट का आईडी है.

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

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

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

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

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

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

एपीआई प्रॉडक्ट के सभी बंडल देखना: किसी संगठन के लिए, एपीआई प्रॉडक्ट के सभी बंडल वापस पाने के लिए, GET अनुरोध /organizations/{org_name}/monetization-packages पर भेजें. उदाहरण के लिए:

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

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

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

{
  "monetizationPackage" : [ {
    "description" : "payment messaging package",
    "displayName" : "Payment Messaging Package",
    "id" : "payment_messaging_package",
    "name" : "Payment Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "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"
  }, {
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "Payment",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  } ],
  "totalRecords" : 3
}

लेन-देन वाले एपीआई प्रॉडक्ट बंडल देखना: किसी तय तारीख की रेंज में, लेन-देन वाले एपीआई प्रॉडक्ट बंडल वापस पाने के लिए, GET अनुरोध भेजें /organizations/{org_name}/packages-with-transactions. अनुरोध भेजते समय, आपको क्वेरी पैरामीटर के तौर पर, तारीख की रेंज के लिए शुरू और खत्म होने की तारीख तय करनी होगी. उदाहरण के लिए, यहां दिए गए अनुरोध से, अगस्त 2013 के महीने में लेन-देन वाले एपीआई प्रॉडक्ट बंडल वापस पाए जाते हैं.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/packages-with-transactions?START_DATE=2013-08-01&END_DATE=2013-08-31" \
-u email:password

जवाब ऐसा दिखना चाहिए (जवाब का सिर्फ़ कुछ हिस्सा दिखाया गया है):

{
  "monetizationPackage" : [ {
    "description" : "Payment Package",
    "displayName" : "Payment Package",
    "id" : "payment_package",
    "name" : "Payment Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "payment api product",
      "displayName" : "payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  }, {
    "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"
  },
     ...
  } ]
}

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

किसी डेवलपर या कंपनी के स्वीकार किए गए एपीआई प्रॉडक्ट बंडल देखने के लिए, क्रमशः इन एपीआई पर GET अनुरोध भेजें:

• /organizations/{org_name}/developers/{developer_id}/monetization-packages. यहां {developer_id}डेवलपर का आईडी (ईमेल पता) है.
• /organizations/{org_name}/companies/{company_id}/monetization-packages. यहां {company_id} कंपनी का आईडी है.

अनुरोध भेजते समय, आपके पास ये क्वेरी पैरामीटर तय करने का विकल्प होता है:

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

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev1@myorg.com/monetization-packages" \
-u email:password

यहां दिए गए अनुरोध से, किसी कंपनी के स्वीकार किए गए सिर्फ़ चालू एपीआई पैकेज वापस पाए जाते हैं:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/myCompany/monetization-packages?current=true" \
-u email:password

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

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

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

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

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

एपीआई के लिए, एपीआई प्रॉडक्ट बंडल के कॉन्फ़िगरेशन की प्रॉपर्टी

एपीआई प्रॉडक्ट बंडल के ये कॉन्फ़िगरेशन विकल्प, एपीआई को दिखते हैं: