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

Apigee Edge का दस्तावेज़ देखा जा रहा है.
Go to the Apigee X documentation. info

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

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

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

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

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

उदाहरण के लिए, यहां दिए गए अनुरोध से, तय किए गए डेवलपर के लिए 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 की वैल्यू 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
}

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