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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   आपको प्रॉडक्ट बंडल पैनल दिखेगा.

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

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

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

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

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

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

एपीआई प्रॉडक्ट बंडल बनाने के लिए, इनके लिए पोस्ट अनुरोध जारी करें /organizations/{org_name}/monetization-packages. अनुरोध करने पर, ज़रूरी है:

• एपीआई प्रॉडक्ट बंडल में शामिल करने के लिए, एपीआई प्रॉडक्ट की पहचान करें.
• एपीआई प्रॉडक्ट बंडल का नाम और जानकारी डालें.
• एपीआई प्रॉडक्ट बंडल के लिए, स्टेटस इंडिकेटर सेट करें. स्थिति दिखाने वाले संकेत में, इनमें से कोई एक ये वैल्यू डालें: 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"
 }

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

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

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

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

किसी एपीआई प्रॉडक्ट बंडल में एपीआई प्रॉडक्ट जोड़ने के लिए, पोस्ट करने का अनुरोध करें 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}, जहां {org_name} आपके संगठन, {package_id} का नाम बताता है एपीआई प्रॉडक्ट बंडल का नाम बताता है और {product_id} एपीआई के आईडी के बारे में बताता है प्रॉडक्ट.

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

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

$ 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}, जहां {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

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

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

कोई खास एपीआई प्रॉडक्ट बंडल देखना: किसी खास एपीआई प्रॉडक्ट बंडल को फिर से पाने के लिए, जीईटी अनुरोध जारी करें /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

सभी एपीआई प्रॉडक्ट बंडल देखना: किसी संगठन के सभी एपीआई प्रॉडक्ट बंडल वापस पाने के लिए, जीईटी जारी करें /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
}

ट्रांज़ैक्शन के साथ एपीआई प्रॉडक्ट बंडल देखना: तारीख की दी गई सीमा में, जीईटी अनुरोध /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"
  },
     ...
  } ]
}

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

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

• /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} तक, जहां {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

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

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