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

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 की वैल्यू को 2017-11-30 पर सेट करना होगा. इस मामले में, किराया प्लान 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} संसाधन के लिए किए गए पुट अनुरोध के अनुरोध बॉडी में endDate प्रॉपर्टी की जानकारी दें.

किराया प्लान, खत्म होने की तय तारीख को दिन के आखिर तक लागू रहेगा. उदाहरण के लिए, अगर आपको किराये के किसी प्लान की समयसीमा 1 दिसंबर, 2017 को खत्म करनी है, तो आपको endDate की वैल्यू को 2017-11-30 पर सेट करना होगा. इस मामले में, किराये का प्लान 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
}

इसके अलावा, /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans पर GET अनुरोध भेजकर, डेवलपर के लिए तय किए गए किराये के प्लान का {developer-rateplan-id} भी पाया जा सकता है. यहां {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
  }'