कमाई करने से जुड़ी सेवाएं इंस्टॉल करना

कमाई करने की सेवाएं, Apigee Edge का एक एक्सटेंशन है. इसलिए, यह अलग से मौजूद प्रोसेस के तौर पर काम नहीं करता. यह किसी भी मौजूदा Apigee Edge सेटअप में काम करता है. हालांकि, यह ऑल-इन-वन (एआईओ) कॉन्फ़िगरेशन में काम नहीं करता. एआईओ कॉन्फ़िगरेशन पर, कमाई करने की सेवाएं इंस्टॉल नहीं की जा सकतीं.

कमाई करने से जुड़ी ज़रूरी शर्तें

  • अगर कमाई करने की सुविधा को ऐसे Edge टोपोलॉजी पर इंस्टॉल किया जा रहा है जो एक से ज़्यादा मैनेजमेंट सर्वर नोड का इस्तेमाल करता है, जैसे कि 13-नोड वाला इंस्टॉलेशन, तो आपको कमाई करने की सुविधा इंस्टॉल करने से पहले, Edge मैनेजमेंट सर्वर के दोनों नोड इंस्टॉल करने होंगे.
  • Edge पर Monetization को इंस्टॉल करने के लिए, जहां Edge इंस्टॉलेशन में कई Postgres नोड हैं, Postgres नोड को मास्टर/स्टैंडबाय मोड में कॉन्फ़िगर किया जाना चाहिए. अगर आपके पास एक से ज़्यादा Postgres मास्टर नोड हैं, तो Edge पर कमाई करने की सुविधा इंस्टॉल नहीं की जा सकती. ज़्यादा जानकारी के लिए, Postgres के लिए मास्टर-स्टैंडबाय रेप्लिकेशन सेट अप करना लेख पढ़ें.
  • ऑल-इन-वन (एआईओ) कॉन्फ़िगरेशन के साथ, कमाई करने की सुविधा उपलब्ध नहीं है.

इंस्टॉल करने के बारे में खास जानकारी

यहां दिए गए चरणों में, पहले से इंस्टॉल किए गए Apigee Edge पर कमाई करने की सेवाएं जोड़ने का तरीका बताया गया है:

  • apigee-setup यूटिलिटी का इस्तेमाल करके, Apigee मैनेजमेंट सर्वर नोड को अपडेट करें, ताकि कमाई करने की सेवाएं चालू की जा सकें. जैसे, कैटलॉग मैनेजमेंट, सीमाएं और सूचनाएं कॉन्फ़िगरेशन, बिलिंग, और रिपोर्टिंग.

    अगर आपके पास एक से ज़्यादा मैनेजमेंट सर्वर नोड हैं, जैसे कि 13-नोड वाला इंस्टॉलेशन, तो आपको कमाई करने की सुविधा इंस्टॉल करने से पहले, Edge मैनेजमेंट सर्वर के दोनों नोड इंस्टॉल करने होंगे.

  • apigee-setup यूटिलिटी का इस्तेमाल करके, Apigee मैसेज प्रोसेसर को अपडेट करें. इससे, कमाई करने की सेवाओं के रनटाइम कॉम्पोनेंट चालू हो जाएंगे. उदाहरण के लिए, लेन-देन रिकॉर्ड करने की नीति और सीमा लागू करना. अगर आपके पास एक से ज़्यादा मैसेज प्रोसेसर हैं, तो उन सभी पर Monetization इंस्टॉल करें.
  • अपने Edge संगठनों के लिए, कमाई करने की सुविधा चालू करने की प्रोसेस पूरी करें.
  • Apigee Developer Services पोर्टल (या सिर्फ़ पोर्टल) को कॉन्फ़िगर करें, ताकि कमाई करने की सुविधा का इस्तेमाल किया जा सके. ज़्यादा जानकारी के लिए, डेवलपर पोर्टल में कमाई करने की सुविधा कॉन्फ़िगर करना लेख पढ़ें.

कमाई करने की सुविधा के लिए, साइलेंट कॉन्फ़िगरेशन फ़ाइल बनाना

यहां Monetization इंस्टॉल करने के लिए, साइलेंट कॉन्फ़िगरेशन फ़ाइल का एक उदाहरण दिया गया है. अपने कॉन्फ़िगरेशन के हिसाब से, इस फ़ाइल में बदलाव करें. इस फ़ाइल को शामिल करने के लिए, 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 कॉन्फ़िगरेशन फ़ाइल में एसएमटीपी की जानकारी नहीं दी गई है, तो उसे जोड़ें. कमाई करने की सुविधा के लिए, एसएमटीपी सर्वर ज़रूरी है.
  • एक डेटा सेंटर इंस्टॉलेशन में, ZooKeeper नोड की विषम संख्याओं को voters के तौर पर कॉन्फ़िगर किया जाना चाहिए. अगर ZooKeeper नोड की संख्या सम है, तो कुछ नोड को observers के तौर पर कॉन्फ़िगर किया जाएगा. जब Edge को डेटा सेंटर की सम संख्या में इंस्टॉल किया जाता है, तो कुछ ZooKeeper नोड को observers के तौर पर कॉन्फ़िगर करना ज़रूरी होता है, ताकि वोटर नोड की संख्या विषम हो सके. ZooKeeper लीडर के चुनाव के दौरान, एक वोटर नोड को leader के तौर पर चुना जाएगा. पक्का करें कि ऊपर दी गई ZK_HOSTS प्रॉपर्टी, एक से ज़्यादा डेटा सेंटर इंस्टॉलेशन में लीडर नोड के बारे में बताती हो.
  • अगर Cassandra की पुष्टि करने की सुविधा चालू की जाती है, तो Cassandra का उपयोगकर्ता नाम और पासवर्ड पास किया जा सकता है. इसके लिए, इन प्रॉपर्टी का इस्तेमाल करें:
    CASS_USERNAME
    CASS_PASSWORD

कमाई करने की सेवाओं को सभी मैनेजमेंट सर्वर के साथ इंटिग्रेट करना

मैनेजमेंट सर्वर नोड पर कमाई करने की सुविधा को इंटिग्रेट करने के लिए, यह तरीका अपनाएं.

  1. अगर कमाई करने की सुविधा को एक से ज़्यादा मैनेजमेंट सर्वर नोड का इस्तेमाल करने वाले Edge टोपोलॉजी पर इंस्टॉल किया जा रहा है, जैसे कि 13-नोड वाला इंस्टॉलेशन, तो पक्का करें कि आपने कमाई करने की सुविधा इंस्टॉल करने से पहले, दोनों मैनेजमेंट सर्वर नोड इंस्टॉल किए हों.
  2. मैनेजमेंट सर्वर नोड पर, सेटअप स्क्रिप्ट चलाएं:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    -p mo विकल्प से, कमाई करने की सुविधा को इंटिग्रेट किया जाता है.

    कॉन्फ़िगरेशन फ़ाइल को "apigee" उपयोगकर्ता ऐक्सेस या पढ़ सकता हो.

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

कॉन्फ़िगरेशन पूरा होने पर, PostgreSQL डेटाबेस में Monetization Services के लिए एक आरडीबीएमएस स्कीमा बन जाता है. इससे, Monetization Services और उससे जुड़े कॉम्पोनेंट का Postgres सर्वर के साथ इंटिग्रेशन पूरा हो जाता है.

कमाई करने की सेवाओं को सभी मैसेज प्रोसेसर के साथ इंटिग्रेट करना

सभी मैसेज प्रोसेसर नोड पर कमाई करने की सुविधा को इंटिग्रेट करने के लिए, यह तरीका अपनाएं.

  1. पहले मैसेज प्रोसेसर नोड पर, कमांड प्रॉम्प्ट में सेटअप स्क्रिप्ट चलाएं:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    -p mo विकल्प से, कमाई करने की सुविधा को इंटिग्रेट किया जाता है.

    कॉन्फ़िगरेशन फ़ाइल को "apigee" उपयोगकर्ता ऐक्सेस या पढ़ सकता हो.

  2. सभी मैसेज प्रोसेसर नोड पर यह तरीका दोहराएं.

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

कमाई करने की सुविधा चालू करना

नया संगठन बनाने और कमाई करने की सुविधा चालू करने के लिए:

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

अगली बार Edge यूज़र इंटरफ़ेस (यूआई) में लॉग इन करने पर, आपको संगठन के लिए टॉप-लेवल मेन्यू में, कमाई करने की सुविधा की एंट्री दिखेगी:

कमाई करने की सुविधा के साथ काम करने के लिए पोर्टल को कॉन्फ़िगर करने के लिए, डेवलपर पोर्टल में कमाई करने की सुविधा को कॉन्फ़िगर करना लेख पढ़ें.

Monetization के इंस्टॉलेशन में मैनेजमेंट सर्वर नोड जोड़ना

अगर किसी मौजूदा Edge इंस्टॉलेशन में मैनेजमेंट सर्वर जोड़ा जाता है, तो आपको यह पक्का करना होगा कि आपने नए मैनेजमेंट सर्वर में कमाई करने की सेवाएं जोड़ी हों. साथ ही, सभी मैनेजमेंट सर्वर को कॉन्फ़िगर किया हो, ताकि वे कम्यूनिकेट कर सकें.

मैनेजमेंट सर्वर जोड़ने के लिए:

  1. नया मैनेजमेंट सर्वर इंस्टॉल करें.
  2. नए मैनेजमेंट सर्वर पर Monetization इंस्टॉल करें.
  3. ओरिजनल मैनेजमेंट सर्वर पर, यह कॉल करें:
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. ओरिजनल मैनेजमेंट सर्वर को रीस्टार्ट करें:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. नए मैनेजमेंट सर्वर पर, इसे कॉल करें:
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. नए मैनेजमेंट सर्वर को रीस्टार्ट करें:
    /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

क्या यह ग्रुप संगठन है (डिफ़ॉल्ट रूप से "गलत" पर सेट होता है)

MINT_HAS_BROKER

Has broken (डिफ़ॉल्ट वैल्यू false है)

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

"PREPAID"/"POSTPAID"/"BOTH" (डिफ़ॉल्ट रूप से "PREPAID" पर सेट होता है)

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

इससे पता चलता है कि संगठन के पास सभी डेवलपर के लिए, सेल्फ़ बिलिंग की सुविधा है या नहीं. डिफ़ॉल्ट रूप से, इसकी वैल्यू "false" होती है

MINT_HAS_SEPARATE_INV_FOR_PROD

इससे पता चलता है कि संगठन के पास हर प्रॉडक्ट के लिए अलग इनवॉइस है या नहीं. डिफ़ॉल्ट रूप से, यह "गलत" पर सेट होता है

MINT_HAS_BILLING_ADJUSTMENT

इससे पता चलता है कि संगठन, बिलिंग अडजस्टमेंट की सुविधा देता है या नहीं. डिफ़ॉल्ट रूप से, यह "गलत" पर सेट होता है

features.isMonetizationEnabled

इसका इस्तेमाल मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) करता है, ताकि कमाई करने से जुड़ा खास मेन्यू दिखाया जा सके. डिफ़ॉल्ट रूप से, इसकी वैल्यू "false" होती है

ui.config.isOperator

मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) इसका इस्तेमाल, सेवा देने वाली कंपनी को ऑपरेटर या संगठन के तौर पर दिखाने के लिए करता है. डिफ़ॉल्ट रूप से, इसकी वैल्यू "सही" पर सेट होती है

मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, कारोबार के संगठन की सेटिंग कॉन्फ़िगर करने के लिए, Edge में कमाई करने की सुविधा ऐक्सेस करना देखें.

कमाई करने की सीमाएं

कमाई करने की सीमाएं लागू करने के लिए, एपीआई प्रॉक्सी में Monetization Limits Check नीति जोड़ें. खास तौर पर, यह नीति इन स्थितियों में लागू होती है:

  • कमाई करने वाले एपीआई को ऐक्सेस करने वाला डेवलपर, रजिस्टर नहीं है या उसने रेट प्लान की सदस्यता नहीं ली है.
  • डेवलपर ने सदस्यता वाले रेट प्लान के लिए, लेन-देन की तय सीमा को पार कर लिया है.
  • डेवलपर के प्रीपेड खाते का बैलेंस या पोस्टपेड क्रेडिट लिमिट खत्म हो गई है.

कमाई करने की सीमाओं की जांच करने वाली नीति, ऊपर बताई गई स्थितियों में गड़बड़ियों की जानकारी देती है और एपीआई कॉल को ब्लॉक करती है. यह नीति, गड़बड़ी की जानकारी देने वाली नीति को एक्सटेंड करती है. साथ ही, गड़बड़ी होने पर मिलने वाले मैसेज को पसंद के मुताबिक बनाया जा सकता है. लागू होने वाली शर्तें, कारोबार के वैरिएबल से तय होती हैं.

ज़्यादा जानकारी के लिए, एपीआई प्रॉक्सी पर कमाई करने की सीमाएं लागू करना लेख पढ़ें.