कमाई करने की सेवाएं, Apigee Edge का एक एक्सटेंशन है. इसलिए, यह अलग से काम नहीं करता. यह, ऑल-इन-वन (एआईओ) कॉन्फ़िगरेशन को छोड़कर, सभी मौजूदा Apigee Edge के सेटअप में चलता है. एआईओ कॉन्फ़िगरेशन पर, कमाई करने से जुड़ी सेवाएं इंस्टॉल नहीं की जा सकतीं.
कमाई करने से जुड़ी ज़रूरी शर्तें
- अगर आपको ऐसे Edge टोपोलॉजी पर कमाई करने की सुविधा इंस्टॉल करनी है जो कई मैनेजमेंट सर्वर नोड, जैसे कि 13-नोड इंस्टॉलेशन का इस्तेमाल करती है, तो कमाई करने की सुविधा इंस्टॉल करने से पहले आपको दोनों एज मैनेजमेंट सर्वर नोड इंस्टॉल करने होंगे.
- EDGE पर कमाई करने की सुविधा इंस्टॉल करने के लिए, जहां Edge इंस्टॉलेशन में कई Postgres नोड हों, वहां Postgres नोड को मास्टर/Standby मोड में कॉन्फ़िगर करना ज़रूरी है. अगर आपके पास एक से ज़्यादा Postgres मास्टर नोड हैं, तो Edge पर कमाई करने की सुविधा इंस्टॉल नहीं की जा सकती. ज़्यादा जानकारी के लिए, Postgres के लिए Master-Standby Replication सेट अप करें देखें.
- कमाई करने की सुविधा, ऑल-इन-वन (एआईओ) कॉन्फ़िगरेशन के साथ उपलब्ध नहीं है.
इंस्टॉलेशन की खास जानकारी
किसी मौजूदा Apigee Edge के इंस्टॉलेशन पर, कमाई करने वाली सेवाएं जोड़ने का तरीका नीचे बताया गया है:
- कमाई करने की सेवाएं चालू करने के लिए,
Apigee मैनेजमेंट सर्वर नोड को अपडेट करने के लिए,
apigee-setup
यूटिलिटी का इस्तेमाल करें. उदाहरण के लिए, कैटलॉग मैनेजमेंट, सीमाएं और सूचनाओं से जुड़ा कॉन्फ़िगरेशन, बिलिंग, और रिपोर्टिंग.अगर आपके पास कई मैनेजमेंट सर्वर नोड हैं, जैसे कि 13-नोड इंस्टॉलेशन, तो कमाई करने की सुविधा इंस्टॉल करने से पहले आपको दोनों एज मैनेजमेंट सर्वर नोड को इंस्टॉल करना होगा.
- कमाई करने की सेवाओं के रनटाइम कॉम्पोनेंट को चालू करने के लिए,
Apigee Message प्रोसेसर को अपडेट करने के लिए,
apigee-setup
सुविधा का इस्तेमाल करें. उदाहरण के लिए, लेन-देन रिकॉर्ड करने की नीति और लागू होने की सीमा तय करना. अगर आपके पास एक से ज़्यादा मैसेज प्रोसेसर हैं, तो उन सभी पर कमाई करने की सुविधा इंस्टॉल करें. - अपने Edge संगठनों के लिए कमाई करने की सुविधा में शामिल होने की प्रोसेस पूरी करें.
- कमाई करने की सुविधा देने के लिए, Apigee Developer Services पोर्टल (या आसान शब्दों में पोर्टल) को कॉन्फ़िगर करें. ज़्यादा जानकारी के लिए, डेवलपर पोर्टल में कमाई करने की सुविधा कॉन्फ़िगर करना लेख पढ़ें.
कमाई करने के लिए साइलेंट कॉन्फ़िगरेशन फ़ाइल बनाना
कमाई करने की सुविधा इंस्टॉल करने के लिए, साइलेंट कॉन्फ़िगरेशन फ़ाइल का एक उदाहरण नीचे दिया गया है. अपने कॉन्फ़िगरेशन के लिए, इस फ़ाइल में ज़रूरत के हिसाब से बदलाव करें. इस फ़ाइल को शामिल करने के लिए, setup.sh के लिए -f विकल्प का इस्तेमाल करें.
# Edge configuration properties # Specify IP address or DNS name of node. IP1=192.168.1.1 # Management Server, OpenLDAP, UI, ZooKeeper, Cassandra IP2=192.168.1.2 # ZooKeeper, Cassandra IP3=192.168.1.3 # ZooKeeper, Cassandra IP4=192.168.1.4 # Router, Message Processor IP5=192.168.1.5 # Router, Message Processor IP6=192.168.1.6 # Qpid IP7=192.168.1.7 # Qpid IP8=192.168.1.8 # Postgres IP9=192.168.1.9 # Postgres # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost. HOSTIP=$(hostname -i) # Edge sys admin credentials ADMIN_EMAIL=your@email.com APIGEE_ADMINPW=yourPassword # If omitted, you are prompted for it. # Specify the Management Server port. APIGEE_PORT_HTTP_MS=8080 # # Monetization configuration properties. # # Postgres credentials from Edge installation. PG_USER=apigee # Default from Edge installation PG_PWD=postgres # Default from Edge installation # Specify Postgres server. MO_PG_HOST="$IP8" # Only specify one Postgres node. # Create a Postgres user for Monetization. # Default username is "postgre". # If you specify a different user, that user must already exist. MO_PG_USER=postgre MO_PG_PASSWD=moUserPWord # Specify one ZooKeeper host. # Ensure this is a ZooKeeper leader node in a multi-datacenter environment. ZK_HOSTS="$IP2" # Specify Cassandra information. # Ensure CASS_HOSTS is set to the same value as when you installed Edge. # Must use IP addresses for CASS_HOSTS, not DNS names. CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1" # Default is "Apigee", unless it was changed during Edge install. CASS_CLUSTERNAME=Apigee # Cassandra uname/pword required only if you enabled Cassandra authentication. # If your password uses special characters, wrap it in single quotes. # CASS_USERNAME= # CASS_PASSWORD= # Specify the region. # Default is dc-1 unless you are in a multi-datacenter environment. REGION=dc-1 # If your Edge config file did not specify SMTP information, add it. # Monetization requires an SMTP server. SMTPHOST=smtp.gmail.com SMTPPORT=465 SMTPUSER=your@email.com SMTPPASSWORD=yourEmailPassword SMTPSSL=y SMTPMAILFROM="My Company <myco@company.com>"
ध्यान दें:
- अगर आपकी Edge की कॉन्फ़िगरेशन फ़ाइल में एसएमटीपी की जानकारी नहीं दी गई है, तो उसे जोड़ दें. कमाई करने के लिए एसएमटीपी सर्वर होना ज़रूरी है.
- किसी एक डेटा सेंटर के इंस्टॉलेशन में, सभी ज़ूकीपर नोड डिफ़ॉल्ट रूप से लीडर के तौर पर कॉन्फ़िगर किए जाते हैं. जब एक से ज़्यादा डेटा सेंटर में Edge इंस्टॉल किया जाता है, तो कुछ ज़ूकीपर नोड को ऑब्ज़र्वर के तौर पर कॉन्फ़िगर किया जाएगा. पक्का करें कि ऊपर दी गई ZK_HostS प्रॉपर्टी, कई डेटा सेंटर इंस्टॉलेशन में एक लीडर नोड तय करती है.
- अगर आपने Cassandra की पुष्टि करने की सुविधा चालू की है, तो इन प्रॉपर्टी का इस्तेमाल करके Cassandra का उपयोगकर्ता नाम और पासवर्ड भेजा जा सकता है:
CASS_USERNAME CASS_PASSWORD
कमाई करने वाली सेवाओं को सभी मैनेजमेंट सर्वर के साथ इंटिग्रेट करें
मैनेजमेंट सर्वर नोड पर कमाई की सुविधा जोड़ने के लिए, नीचे दी गई प्रक्रिया का इस्तेमाल करें.
- अगर आपको ऐसे एज टोपोलॉजी पर कमाई करने की सुविधा इंस्टॉल करनी है जो कई मैनेजमेंट सर्वर नोड, जैसे कि 13-नोड इंस्टॉलेशन का इस्तेमाल करता है, तो कमाई करने की सुविधा इंस्टॉल करने से पहले पक्का कर लें कि आपने दोनों मैनेजमेंट सर्वर नोड इंस्टॉल कर लिए हैं.
- मैनेजमेंट सर्वर नोड पर, सेटअप स्क्रिप्ट चलाएं:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
-p mo
विकल्प में कमाई करने की सुविधा शामिल की गई है.कॉन्फ़िगरेशन फ़ाइल ऐसी होनी चाहिए जिसे "apigee" उपयोगकर्ता ऐक्सेस कर सके या पढ़ सके.
- अगर एक से ज़्यादा मैनेजमेंट सर्वर नोड पर कमाई करने की सुविधा इंस्टॉल की जा रही है, तो दूसरे चरण को दूसरे मैनेजमेंट सर्वर नोड पर दोहराएं.
कॉन्फ़िगरेशन पूरा होने पर, PostgreSQL के डेटाबेस में कमाई करने की सेवाओं के लिए RDBMS स्कीमा बनाया गया. इससे, कमाई करने से जुड़ी सेवाओं और उनसे जुड़े कॉम्पोनेंट को Postgres Server के साथ इंटिग्रेट किया जाता है.
सभी मैसेज प्रोसेसर के साथ, कमाई करने से जुड़ी सेवाओं को इंटिग्रेट करें
सभी मैसेज प्रोसेसर नोड पर कमाई करने की सुविधा जोड़ने के लिए, नीचे दी गई प्रोसेस का इस्तेमाल करें.
- पहले मैसेज प्रोसेसर नोड पर, कमांड प्रॉम्प्ट पर, सेटअप स्क्रिप्ट चलाएं:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
-p mo
विकल्प में कमाई करने की सुविधा शामिल की गई है.कॉन्फ़िगरेशन फ़ाइल ऐसी होनी चाहिए जिसे "apigee" उपयोगकर्ता ऐक्सेस कर सके या पढ़ सके.
- यह प्रोसेस सभी मैसेज प्रोसेसर नोड पर दोहराएं.
कॉन्फ़िगरेशन पूरा होने पर, मैसेज प्रोसेसर को कमाई करने की सेवाओं के साथ अपडेट कर दिया जाता है. इससे, कमाई करने की सेवाओं और उनसे जुड़े कॉम्पोनेंट को मैसेज प्रोसेसर के साथ इंटिग्रेट किया जाता है.
कमाई करने की सुविधा चालू करना
नया संगठन बनाने और कमाई करने की सुविधा चालू करने के लिए:
- किसी भी नए संगठन की तरह ही संगठन बनाएं. ज़्यादा जानकारी के लिए, संगठन को शामिल करना देखें.
- किसी संगठन के लिए कमाई करने की सुविधा चालू करें में बताए गए तरीके से, कमाई करने के प्रॉविज़निंग एपीआई का इस्तेमाल करें. ऐसा करने के लिए, आपके पास सिस्टम एडमिन के खास अधिकार होने चाहिए.
जब आप Edge यूज़र इंटरफ़ेस (यूआई) में अगली बार लॉग इन करते हैं, तो आपको संगठन के लिए टॉप-लेवल मेन्यू में कमाई करने से जुड़ी एंट्री दिखेगी:
कमाई करने में मदद करने के लिए पोर्टल को कॉन्फ़िगर करने के लिए, डेवलपर पोर्टल में कमाई करने की सुविधा कॉन्फ़िगर करें देखें.
कमाई करने से जुड़ी इंस्टॉलेशन में मैनेजमेंट सर्वर नोड जोड़ना
अगर किसी मौजूदा Edge को इंस्टॉल करने के लिए मैनेजमेंट सर्वर जोड़ा जाता है, तो आपको यह पक्का करना होगा कि आपने नए मैनेजमेंट सर्वर में कमाई करने से जुड़ी सेवाएं जोड़ी हैं. साथ ही, सभी मैनेजमेंट सर्वर कॉन्फ़िगर करने होंगे, ताकि वे आपस में इंटरैक्ट कर सकें.
मैनेजमेंट सर्वर जोड़ने के लिए:
- नया मैनेजमेंट सर्वर इंस्टॉल करें.
- नए मैनेजमेंट सर्वर पर, कमाई करने की सुविधा इंस्टॉल करें.
- ओरिजनल मैनेजमेंट सर्वर पर, इसे कॉल करें:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- ओरिजनल मैनेजमेंट सर्वर को रीस्टार्ट करें:
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
- नए मैनेजमेंट सर्वर पर, इसे कॉल करें:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- नए मैनेजमेंट सर्वर को रीस्टार्ट करें:
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
अतिरिक्त कॉन्फ़िगरेशन
बिलिंग दस्तावेज़ों को PDF फ़ाइलों के तौर पर उपलब्ध कराना
कमाई करने की सुविधा, असली उपयोगकर्ताओं को बिलिंग के दस्तावेज़ एचटीएमएल फ़ॉर्मैट में दिखाती है. बिलिंग दस्तावेज़ों को PDF फ़ाइलों के तौर पर उपलब्ध कराने के लिए, कमाई करने की सुविधा को ऐसे बिलिंग सिस्टम के साथ इंटिग्रेट किया जा सकता है जो PDF जनरेट करता हो या तीसरे पक्ष की ऐसी PDF लाइब्रेरी का लाइसेंस देता हो जो इस सुविधा के साथ काम करती हो.
संगठन की सेटिंग कॉन्फ़िगर करें
संगठन के एट्रिब्यूट जोड़ने/अपडेट करने के लिए, PUT
अनुरोध का इस्तेमाल किया जा सकता है, जैसा कि नीचे दिए गए उदाहरण में बताया गया है:
curl -u SYS_ADMIN_EMAIL:SYS_ADMIN_PASSWORD \ -v http://ms_IP:8080/v1/organizations/orgId -d 'org object with attributes' -X PUT
कमाई करने की सुविधा, संगठन की सेटिंग के हिसाब से काम करती है. उदाहरण के लिए:
{ ... "displayName": "Orgnization name", "name": "org4", "properties": { "property": [ ... { "name": "MINT_CURRENCY", "value": "USD" }, { "name": "MINT_COUNTRY", "value": "US" }, { "name": "MINT_TIMEZONE", "value": "GMT" } ] } }
नीचे दी गई टेबल में संगठन-लेवल के उन एट्रिब्यूट की सूची दी गई है जो किसी मिंट संगठन को कॉन्फ़िगर करने के लिए उपलब्ध हैं.
एट्रिब्यूट | ब्यौरा |
---|---|
MINT_TAX_MODEL
|
स्वीकार की जाने वाली वैल्यू हैं "DISCLOSED", "UNDISCLOSED", "HYBRID" (डिफ़ॉल्ट वैल्यू शून्य है) |
MINT_CURRENCY
|
आईएसओ मुद्रा कोड (डिफ़ॉल्ट रूप से शून्य है) |
MINT_TAX_NEXUS
|
टैक्स नेक्सस (डिफ़ॉल्ट तौर पर शून्य है) |
MINT_DEFAULT_PROD_TAX_CATEGORY
|
प्रॉडक्ट के लिए डिफ़ॉल्ट टैक्स कैटगरी (डिफ़ॉल्ट वैल्यू शून्य है) |
MINT_IS_GROUP_ORG
|
IS ग्रुप का संगठन (डिफ़ॉल्ट तौर पर, यह "गलत" पर सेट होता है) |
MINT_HAS_BROKER
|
इसमें गड़बड़ी है (डिफ़ॉल्ट तौर पर, यह 'गलत' पर सेट होता है) |
MINT_TIMEZONE
|
समय क्षेत्र (डिफ़ॉल्ट रूप से शून्य पर सेट है) |
MINT_TAX_ENGINE_EXTERNAL_ID
|
टैक्स इंजन आईडी (डिफ़ॉल्ट वैल्यू शून्य है) |
MINT_COUNTRY
|
संगठन का देश (डिफ़ॉल्ट, शून्य है) |
MINT_REG_NO
|
संगठन का रजिस्ट्रेशन नंबर, यूनाइटेड किंगडम, टैक्स आईडी से अलग नंबर देता है (डिफ़ॉल्ट तौर पर, वैल्यू शून्य होती है) |
MINT_BILLING_CYCLE_TYPE
|
"PRORATED", "CALENDAR_MONTH" (डिफ़ॉल्ट रूप से "CALENDAR_MONTH" है) |
MINT_SUPPORTED_BILLING_TYPE
|
"प्रीपेड"/"पोस्टपेड"/"दोनों" (डिफ़ॉल्ट रूप से "प्रीपेड"/"पोस्टपेड" होता है) |
MINT_IS_SEPARATE_INV_FOR_FEES
|
इससे यह पता चलता है कि शुल्क का एक अलग इनवॉइस जनरेट करना है या नहीं (डिफ़ॉल्ट तौर पर, यह "गलत" पर सेट होता है) |
MINT_ISSUE_NETTING_STMT
|
इससे पता चलता है कि नेटिंग स्टेटमेंट जारी किया जाना चाहिए या नहीं (डिफ़ॉल्ट तौर पर, यह "गलत" पर सेट होती है) |
MINT_NETTING_STMT_PER_CURRENCY
|
इससे यह पता चलता है कि क्या नेटिंग स्टेटमेंट, मुद्रा के हिसाब से जनरेट होना चाहिए (डिफ़ॉल्ट तौर पर, यह "गलत" पर सेट होता है) |
MINT_HAS_SELF_BILLING
|
इससे पता चलता है कि संगठन को खुद से पैसे चुकाने की सुविधा है या नहीं (डिफ़ॉल्ट तौर पर यह "गलत" पर सेट होता है) |
MINT_SELF_BILLING_FOR_ALL_DEV
|
इससे पता चलता है कि संगठन ने सभी डेवलपर को खुद से पैसे चुकाने की सुविधा दी है या नहीं (डिफ़ॉल्ट तौर पर, यह "गलत" पर सेट होता है) |
MINT_HAS_SEPARATE_INV_FOR_PROD
|
इससे पता चलता है कि क्या संगठन के पास हर प्रॉडक्ट के लिए अलग इनवॉइस है (डिफ़ॉल्ट तौर पर, वैल्यू "गलत" पर सेट होती है) |
MINT_HAS_BILLING_ADJUSTMENT
|
इससे पता चलता है कि संगठन में बिलिंग अडजस्टमेंट काम करते हैं या नहीं (डिफ़ॉल्ट तौर पर, यह "गलत" पर सेट होता है) |
features.isMonetizationEnabled
|
मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) में इसका इस्तेमाल, कमाई करने से जुड़ा मेन्यू दिखाने के लिए किया जाता है (डिफ़ॉल्ट वैल्यू "गलत" पर सेट होती है) |
ui.config.isOperator
|
मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) इसका इस्तेमाल, सेवा देने वाली कंपनी को ऑपरेटर वर्सेज़ संगठन के तौर पर दिखाने के लिए करता है (डिफ़ॉल्ट यह "सही" होता है) |
मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, कारोबारी संगठन की सेटिंग कॉन्फ़िगर करने के लिए, कमाई करने की सुविधा का इस्तेमाल शुरू करना देखें.
कमाई करने की सीमाएं
कमाई करने की सीमाएं लागू करने के लिए, एपीआई प्रॉक्सी में कमाई करने की सीमाओं की जांच करने से जुड़ी नीति जोड़ें. खास तौर पर, नीति को इन स्थितियों में ट्रिगर किया जाता है:
- कमाई करने वाले एपीआई को ऐक्सेस करने वाले डेवलपर ने, या तो रजिस्टर नहीं किया है या उसने रेट प्लान की सदस्यता नहीं ली है.
- सदस्यता वाले रेट प्लान के लिए, डेवलपर ने लेन-देन की तय संख्या पार कर ली है.
- डेवलपर के प्रीपेड खाते में बाकी बैलेंस या पोस्ट-पेड क्रेडिट की सीमा खत्म हो गई है.
कमाई करने की सीमाओं की जांच करने से जुड़ी नीति, गड़बड़ियों को बढ़ाती है. साथ ही, ऊपर बताई गई स्थितियों में एपीआई कॉल को ब्लॉक कर देती है. यह नीति गलती से जुड़ी समस्या को ठीक करने की नीति के बारे में ज़्यादा जानकारी देती है. साथ ही, वापस किए जाने वाले मैसेज को अपनी पसंद के मुताबिक बनाया जा सकता है. लागू होने वाली शर्तें, कारोबार के वैरिएबल से तय होती हैं.
ज़्यादा जानकारी के लिए, एपीआई प्रॉक्सी पर कमाई करने की सीमाएं लागू करना देखें.