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

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

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

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

रेट प्लान पब्लिश होने के बाद, डेवलपर या कंपनी इसे खरीद (या "स्वीकार") कर सकती है. इसे /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans को पोस्ट करने का अनुरोध भेजकर, खरीदा जा सकता है. इसमें {org_name} संगठन का नाम है और {developer_or_company_id}, डेवलपर या कंपनी का आईडी है.

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

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

नाम	ब्यौरा	डिफ़ॉल्ट	ज़रूरी है?
startDate	रेट प्लान शुरू होने की तारीख. उदाहरण के लिए: 2017-03-24.	लागू नहीं	हां
endDate	रेट प्लान खत्म होने की तारीख. उदाहरण के लिए: 2017-09-24. किराया तय करने का प्लान, तय की गई तारीख को दिन के आखिर तक लागू रहेगा. उदाहरण के लिए, अगर आपको रेट प्लान की समयसीमा 1 दिसंबर, 2017 को खत्म करनी है, तो आपको endDate की वैल्यू को 30-11-2017 पर सेट करना होगा. इस मामले में, रेट प्लान की समयसीमा 30 नवंबर, 2017 को दिन के आखिर में खत्म हो जाएगी. साथ ही, 1 दिसंबर, 2017 को किए गए सभी अनुरोध ब्लॉक कर दिए जाएंगे.	लागू नहीं	नहीं
developer	id प्रॉपर्टी, जो रेट प्लान खरीदने वाले डेवलपर या कंपनी के आईडी के बारे में बताती है.	लागू नहीं	हां
quotaTarget	ऐप्लिकेशन डेवलपर के लिए, लेन-देन की टारगेट संख्या. टारगेट की गई संख्या के कितने प्रतिशत हिस्से तक पहुंचा जा चुका है, जैसे कि 90%, 100% या 150%. टारगेट की संख्या पूरी होने के बाद, दूसरे लेन-देन पर रोक नहीं लगाई जाती है. किसी ऐप्लिकेशन डेवलपर के लिए सूचनाएं बंद करने के लिए, इस वैल्यू को पॉज़िटिव पूर्णांक या 0 पर सेट करें.	0	नहीं
ratePlan	id प्रॉपर्टी, जो रेट प्लान का आईडी तय करती है. रेट प्लान का आईडी, डिसप्ले नेम से अलग होता है. रेट प्लान की जानकारी और आईडी देखने के लिए, रेट प्लान को एक्सप्लोर करने वाले पेज पर जाएं.	लागू नहीं	हां
suppressWarning	यह फ़्लैग बताता है कि अगर डेवलपर, खरीदे गए किसी अन्य रेट प्लान को ओवरलैप करने वाला रेट प्लान खरीदने की कोशिश करता है, तो गड़बड़ी को रोका जाए या नहीं. वैल्यू इनमें से कोई एक हो सकती है: true - कमाई करने की सुविधा चालू होने पर, डेवलपर के लिए खरीदे गए वे सभी रेट प्लान खत्म हो जाते हैं जो एपीआई पैकेज में शामिल होते हैं. इन पैकेज में, एपीआई वाले अलग-अलग प्रॉडक्ट शामिल होते हैं. इसके बाद, वह डेवलपर के लिए एक नया एपीआई पैकेज खरीदता है. false - ओवरलैप होने वाला रेट प्लान होने की स्थिति में गड़बड़ी होती है.	लागू नहीं	नहीं
waveTerminationCharge	यह फ़्लैग बताता है कि नए रेट प्लान को चालू करने के दौरान, चालू रेट प्लान को खत्म करने पर प्लान खत्म करने का शुल्क माफ़ किया जाएगा या नहीं. वैल्यू इनमें से कोई एक हो सकती है: true - नए रेट प्लान को चालू करने के दौरान, अगर किसी चालू रेट प्लान को बंद कर दिया जाता है, तो सदस्यता खत्म करने का शुल्क माफ़ करें. false - नए रेट प्लान को चालू करने के बाद, अगर कोई चालू रेट प्लान खत्म हो जाता है, तो उसे खत्म करने का शुल्क न देना.	लागू नहीं	नहीं

उदाहरण के लिए, यह अनुरोध, किसी खास डेवलपर के लिए location_&_messaging का किराया प्लान खरीदता है:

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "startDate":"2017-08-30",
   "ratePlan":{
     "id":"location_&_messaging"
   },
   "suppressWarning":false
  }'

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

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

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "ratePlan":{
     "id":"adjustable-notification-plan"
   },
   "startDate": "2017-03-24",
   "quotaTarget": 4000,
   "suppressWarning":false
  }'

ऊपर दिए गए किसी भी उदाहरण में, अगर गड़बड़ी का यह मैसेज दिखता है:

Developer legal name not specified. 

इसके बाद, आपको कमाई करने से जुड़े एट्रिब्यूट MINT_DEVELOPER_ADDRESS और MINT_DEVELOPER_LEGAL_NAME को सेट करना होगा. इसके बाद, एपीआई कॉल को दोहराना होगा.

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

डेवलपर के खरीदे गए रेट प्लान की समयसीमा खत्म होने (या रद्द करने) के लिए, खरीदे गए रेट प्लान की जानकारी अपडेट करें. साथ ही, /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id} संसाधन में PUT अनुरोध में, endDate प्रॉपर्टी की जानकारी दें.

रेट प्लान, तय की गई तारीख पर दिन के आखिर तक लागू रहेगा. उदाहरण के लिए, अगर आपको 1 दिसंबर, 2017 तक रेट प्लान की समयसीमा खत्म करनी है, तो आपको endDate की वैल्यू को 30-11-2017 पर सेट करना होगा. इस मामले में, दर योजना 30 नवंबर, 2017 को दिन के आखिर में खत्म हो जाएगी; 1 दिसंबर, 2017 को किए गए सभी अनुरोध ब्लॉक कर दिए जाएंगे.

पब्लिश किया गया रेट प्लान खरीदने पर, रिस्पॉन्स के तौर पर {developer_rateplan_id} दिखाया जाता है.

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

{
  "created": "2017-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2017-03-31 00:00:00",
  "updated": "2017-03-31 18:59:54",
  "waiveTerminationCharge": false
}

इसके अलावा, डेवलपर रेट प्लान के लिए {developer-rateplan-id} पाया जा सकता है. इसके लिए, /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans पर जीईटी अनुरोध जारी करें. यहां {developer_id}, डेवलपर का ईमेल पता है. ज़्यादा जानकारी के लिए, डेवलपर के खरीदे गए सभी रेट प्लान देखना लेख पढ़ें.

नीचे दिए गए अनुरोध में, खत्म होने की तारीख 1 दिसंबर, 2017 अपडेट कर दी गई है. इसका मतलब है कि रेट प्लान 30 नवंबर, 2017 को दिन के आखिर में खत्म हो जाएगा. 1 दिसंबर, 2017 को किए गए सभी अनुरोध ब्लॉक कर दिए जाएंगे.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
  -X PUT \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2017-04-15 00:00:00",
   "endDate": "2017-11-30",
   "quotaTarget": 3000,
   "suppressWarning":false
  }'