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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

कमाई करने की सुविधा वाले इंस्टॉलेशन में मैनेजमेंट सर्वर नोड जोड़ना

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

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

  1. नया मैनेजमेंट सर्वर इंस्टॉल करें.
  2. नए मैनेजमेंट सर्वर पर, कमाई करने की सुविधा इंस्टॉल करें.
  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

ISO मुद्रा कोड (डिफ़ॉल्ट रूप से शून्य है)
MINT_TAX_NEXUS

टैक्स नेक्सस (डिफ़ॉल्ट रूप से शून्य)
MINT_DEFAULT_PROD_TAX_CATEGORY

प्रॉडक्ट की टैक्स कैटगरी का डिफ़ॉल्ट वैल्यू (डिफ़ॉल्ट रूप से कोई वैल्यू नहीं)
MINT_IS_GROUP_ORG

IS group organization (default is "false")
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

"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

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

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

इससे पता चलता है कि संगठन, बिलिंग में बदलाव करने की सुविधा देता है या नहीं (डिफ़ॉल्ट तौर पर, "गलत")
features.isMonetizationEnabled

इसका इस्तेमाल कमाई करने से जुड़ा खास मेन्यू दिखाने के लिए मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) करता है (डिफ़ॉल्ट रूप से यह "गलत" होता है)
ui.config.isOperator

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

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

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

कमाई करने की सीमाएं लागू करने के लिए, एपीआई प्रॉक्सी से कमाई करने की सीमाओं की जांच करने की नीति अटैच करें. खास तौर पर, नीति इन शर्तों के तहत ट्रिगर होती है:

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

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

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