आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
परिचय
सूचनाओं के लिए तय किए गए प्लान में, एपीआई उपलब्ध कराने वाली कंपनी, हर ऐप्लिकेशन डेवलपर के लिए लेन-देन की टारगेट संख्या में बदलाव कर सकती है. आपके पास यह कॉन्फ़िगर करने का विकल्प होता है कि टारगेट नंबर का कोई प्रतिशत (जैसे, 90%, 100% या 150%) पूरा होने पर सूचनाएं भेजी जाएं या नहीं. टारगेट नंबर तक पहुंचने के बाद, अतिरिक्त लेन-देन ब्लॉक नहीं किए जाते.
यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, सूचनाओं के ऐसे प्लान को कॉन्फ़िगर करना जिसमें बदलाव किया जा सकता है
सूचनाओं के प्लान को अपनी ज़रूरत के हिसाब से कॉन्फ़िगर करें. इसके लिए, यहां दिया गया तरीका अपनाएं.
Edge
Edge UI का इस्तेमाल करके, सूचना के प्लान में बदलाव करने की सुविधा को कॉन्फ़िगर करने के लिए, दर प्लान को जोड़ते या बदलते समय, सूचना के प्लान में बदलाव करने की सुविधा वाला दर प्लान टाइप चुनें. इसके बाद, सूचना के प्लान में बदलाव करने की सुविधा सेक्शन में जाकर, यह जानकारी कॉन्फ़िगर करें:
| फ़ील्ड | ब्यौरा | डिफ़ॉल्ट |
|---|---|---|
| कैलकुलेशन की फ़्रीक्वेंसी | वह समयावधि जिसके दौरान लेन-देन की संख्या (या कस्टम एट्रिब्यूट से जुड़ी संख्या) का हिसाब लगाया जाता है. महीनों की संख्या चुनें (1 से 24 महीने). | 1 महीना |
अगर आपने एपीआई प्रॉडक्ट के लिए कस्टम एट्रिब्यूट तय किए हैं, तो कस्टम रेटिंग पैरामीटर को कॉन्फ़िगर किया जा सकता है. इससे कस्टम एट्रिब्यूट के आधार पर लेन-देन काउंटर तय किया जा सकता है.
उदाहरण के लिए, आपको ये काम करने पड़ सकते हैं:
- एपीआई कॉल के मैसेज में दी गई वैल्यू के आधार पर, डेवलपर से अलग-अलग शुल्क लेना.
उदाहरण के लिए, एपीआई अनुरोध में ट्रांसफ़र किए गए बाइट की संख्या के आधार पर, ऐप्लिकेशन डेवलपर से शुल्क लिया जा सकता है. - एक ही लेन-देन में कई एपीआई कॉल बंडल करें.
इस मामले में, 'कस्टम रेटिंग पैरामीटर का इस्तेमाल करें' को चुनें. इसके बाद, ड्रॉप-डाउन सूची से कस्टम एट्रिब्यूट चुनें.
ज़्यादा जानकारी के लिए, कस्टम एट्रिब्यूट के साथ किराया प्लान कॉन्फ़िगर करना लेख पढ़ें.
Classic Edge (Private Cloud)
Classic Edge UI का इस्तेमाल करके, सूचनाओं के ऐसे प्लान कॉन्फ़िगर करने के लिए जिनमें बदलाव किया जा सकता है:
- किराया प्लान विंडो में, प्लान की जानकारी टैब पर मौजूद किराया प्लान का टाइप फ़ील्ड में, एडजस्ट की जा सकने वाली सूचना चुनें.
रेट प्लान विंडो को ऐक्सेस करने के बारे में जानने के लिए, यूज़र इंटरफ़ेस का इस्तेमाल करके रेट प्लान बनाना लेख पढ़ें.
- रिन्यूअल की अवधि फ़ील्ड में, महीनों की वह संख्या डालें जिसके बाद प्लान अपने-आप रिन्यू हो जाता है. हालांकि, अगर डेवलपर इस तारीख से पहले समझौते को खत्म कर देता है, तो प्लान रिन्यू नहीं होगा. अगर आपने इस वैल्यू को 0 पर सेट किया है, तो प्लान तब तक लागू रहेगा, जब तक डेवलपर इसे खत्म नहीं कर देता.
- जेनेरिक रेट प्लान में जाकर, जानकारी पर क्लिक करें.
- एग्रीगेशन का आधार, उस समयावधि पर सेट करें जिसके हिसाब से लेन-देन की संख्या को एग्रीगेट किया जाता है. एक से 24 महीने के बीच की कोई अवधि चुनें. डिफ़ॉल्ट रूप से, इसकी वैल्यू एक महीने होती है.
- लागू करें और बंद करें पर क्लिक करें.
- ड्राफ़्ट सेव करें पर क्लिक करें.
- प्लान को सिर्फ़ तब पब्लिश करें, जब आपको पक्का हो कि यह फ़ाइनल है. पब्लिश करने की तारीख सेट करने और प्लान पब्लिश करने के बारे में जानकारी पाने के लिए, पब्लिश करने के लिए उपलब्ध प्लान देखें.
किराया प्लान पब्लिश करने के बाद, सिर्फ़ उसके खत्म होने की तारीख में बदलाव किया जा सकता है. पब्लिश किए गए किसी भी किराया प्लान को मिटाया नहीं जा सकता. हालांकि, पब्लिश किए गए किराया प्लान की समयसीमा खत्म करना लेख में बताए गए तरीके से, किराया प्लान की समयसीमा खत्म की जा सकती है. इसके बाद, उसे आने वाले समय के किराया प्लान से बदला जा सकता है.
एपीआई का इस्तेमाल करके, सूचनाओं के लिए अडजस्ट किए जा सकने वाले प्लान को कॉन्फ़िगर करना
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
पर POST अनुरोध में, अनुरोध के मुख्य हिस्से में मौजूद ratePlanDetails प्रॉपर्टी
में, सूचना से जुड़ी योजना की जानकारी दें.
बदले जा सकने वाले सूचना प्लान के लिए, अनुरोध के मुख्य हिस्से के ratePlanDetails में ये वैल्यू तय करें:
| प्रॉपर्टी | वैल्यू |
|---|---|
type |
USAGE_TARGET पर सेट करें. |
meteringType |
DEV_SPECIFIC पर सेट करें. |
duration |
एग्रीगेशन के आधार के लिए समय की अवधि पर सेट किया जाता है. साथ ही, durationType पर भी सेट किया जाता है. सूचना की दर को घटाने या बढ़ाने की सुविधा वाले प्लान के लिए, इसे 1 से 24 के बीच की कोई पूर्णांक वैल्यू पर सेट करें. |
durationType |
एग्रीगेशन के आधार के लिए समय की अवधि पर सेट किया गया है. साथ ही, |
सूचना के प्लान की जानकारी को अडजस्ट करने के लिए, कॉन्फ़िगरेशन की जिन प्रॉपर्टी को सेट किया जा सकता है उनके बारे में ज़्यादा जानने के लिए, किराये के प्लान की जानकारी के कॉन्फ़िगरेशन की सेटिंग देखें.
उदाहरण के लिए, यहां एक ऐसे सूचना प्लान के बारे में बताया गया है जिसमें सूचनाएं भेजने की फ़्रीक्वेंसी को घटाया या बढ़ाया जा सकता है. इसमें सूचनाएं एग्रीगेट करने की अवधि एक महीने पर सेट की गई है.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "AdjustableNotification",
"displayName": "Adjustable notification plan",
"description": "Adjustable notification plan",
"published": "true",
"organization": {
"id": "myorg"
},
"startDate": "2016-04-15 00:00:00",
"type": "STANDARD",
"monetizationPackage": {
"id": "p1",
"name": "test"
},
"currency": {
"id" : "usd",
"name" : "USD"
},
"ratePlanDetails": [
{
"type": "USAGE_TARGET",
"meteringType": "DEV_SPECIFIC",
"duration": 1,
"durationType": "MONTH",
"ratingParameter": "VOLUME",
"organization": {
"id": "myorg"
},
"currency": {
"id": "usd",
"name": "USD"
}
}
]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans" \
-u email:password
एपीआई का इस्तेमाल करने वाले हर ऐप्लिकेशन डेवलपर के लिए, ट्रांज़ैक्शन की टारगेट संख्या सेट करना
ऐप्लिकेशन डेवलपर के लिए, लेन-देन की टारगेट संख्या सेट की जा सकती है. ऐसा तब किया जा सकता है, जब डेवलपर, रेट प्लान स्वीकार कर लेता है. बाद में, इस वैल्यू को अपडेट किया जा सकता है.
किराया प्लान स्वीकार करते समय, लेन-देन की टारगेट संख्या सेट करना
किराया प्लान स्वीकार करते समय, लेन-देन की टारगेट संख्या सेट करने के लिए, /organizations/{org_name}/developers/{developer_id}/developer-rateplans संसाधन को POST अनुरोध में अनुरोध के मुख्य हिस्से में
quotaTarget प्रॉपर्टी तय करें.
ऐप्लिकेशन डेवलपर के लिए सूचनाएं बंद करने के लिए, quotaTarget को पॉज़िटिव पूर्णांक या 0 पर सेट करें. अगर quotaTarget की वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से इसकी वैल्यू 0 होती है.
उदाहरण के लिए, यहां दिए गए अनुरोध में लेन-देन की टारगेट संख्या 4,000 पर सेट की गई है. ऐसा तब होता है, जब ऐप्लिकेशन डेवलपर, सूचनाओं के प्लान में बदलाव करने की सुविधा स्वीकार करता है.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"developer":{
"id":"dev@mycompany.org"
},
"ratePlan":{
"id":"p1_adjustable-notification-plan"
},
"startDate": "2016-03-24 00:00:00",
"quotaTarget": 4000,
"suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password
स्वीकार किए गए रेट प्लान को अपडेट करते समय, लेन-देन की टारगेट संख्या सेट करना
लेन-देन की टारगेट संख्या सेट करने के लिए, स्वीकार किया गया रेट प्लान अपडेट किया जा सकता है. साथ ही,
quotaTarget प्रॉपर्टी को
/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}
रिसॉर्स के लिए PUT अनुरोध में, अनुरोध के मुख्य हिस्से में शामिल किया जा सकता है. ऐप्लिकेशन डेवलपर के लिए सूचनाएं बंद करने के लिए, quotaTarget को पॉज़िटिव पूर्णांक या 0 पर सेट करें. अगर quotaTarget की वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से इसकी वैल्यू 0 होती है.
पब्लिश किए गए किराया प्लान को स्वीकार करने पर, जवाब में {developer_rateplan_id} दिखता है.
उदाहरण के लिए:
{
"created": "2016-03-31 18:59:54",
"developer": {
...
},
"id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
"quotaTarget": 3000,
"ratePlan": {
...
},
"startDate": "2016-03-31 00:00:00",
"updated": "2016-03-31 18:59:54",
"waiveTerminationCharge": false
}
इसके अलावा, डेवलपर के लिए तय की गई दर वाला {developer-rateplan-id} प्लान पाने के लिए, /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans पर जीईटी अनुरोध भेजें. यहां {developer_id} डेवलपर का ईमेल पता है. ज़्यादा जानकारी के लिए, डेवलपर के स्वीकार किए गए सभी रेट प्लान देखना लेख पढ़ें.
उदाहरण के लिए:
{
"developerRatePlan": [
{
"created": "2016-03-31 14:52:30",
"developer": {
...
},
"id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
"quotaTarget": 3000,
"ratePlan": {
...
},
"startDate": "2016-03-31 00:00:00",
"updated": "2016-03-31 18:59:54"
}
],
"totalRecords": 1
}
यहां दिए गए अनुरोध में, लेन-देन की टारगेट संख्या को 4,000 पर अपडेट किया गया है.
$ curl -H "Content-Type:application/json" -X PUT -d \
'{
"id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
"developer":{
"id":"dev@mycompany.com"
},
"ratePlan":{
"id":"p1_adjustable-notification-plan"
},
"startDate": "2016-04-15 00:00:00",
"quotaTarget": 4000,
"suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password