تثبيت "خدمات تحقيق الربح"

الإصدار 4.17.05 من Edge for Private Cloud

"خدمات تحقيق الربح" هي إضافة إلى Apigee Edge، وبالتالي لا تعمل كعملية مستقلة. ويتم تشغيله ضمن أي إعداد حالي لـ Apigee Edge.

متطلبات تحقيق الربح

• إذا كنت بصدد تثبيت ميزة "تحقيق الربح" على هيكلية Edge تستخدم عُقدًا متعددة لخادم الإدارة، مثل تثبيت 13 عقدة، يجب تثبيت عقدتَي خادم إدارة Edge قبل تثبيت ميزة "تحقيق الربح".
• لتثبيت ميزة "تحقيق الربح" على Edge حيث يتضمّن تثبيت Edge عدة عُقد Postgres، يجب ضبط عُقد Postgres في وضع "الرئيسي/الاحتياطي". لا يمكنك تثبيت ميزة "تحقيق الربح" على Edge إذا كانت لديك عدة عُقد رئيسية في Postgres. لمزيد من المعلومات، يُرجى الاطّلاع على إعداد النسخ المتماثل الرئيسي/الاحتياطي لـ Postgres.

نظرة عامة على عملية التثبيت

توضّح الخطوات التالية كيفية إضافة "خدمات تحقيق الربح" إلى عملية تثبيت حالية لـ Apigee Edge:

• استخدِم الأداة المساعدة apigee-setup لتحديث عقدة خادم إدارة Apigee من أجل تفعيل "خدمات تحقيق الربح"، مثل إدارة الكتالوج وضبط الحدود والإشعارات والفوترة وإعداد التقارير.
  
  إذا كانت لديك عُقد متعددة في Management Server، مثل تثبيت 13 عُقدة، يجب تثبيت عُقدتَي Edge Management Server قبل تثبيت ميزة "تحقيق الربح".
• استخدِم الأداة المساعدة apigee-setup لتعديل "معالج رسائل Apigee" من أجل تفعيل مكوّنات وقت التشغيل في "خدمات تحقيق الربح"، مثل سياسة تسجيل المعاملات وفرض الحدود. إذا كان لديك عدّة معالِجات رسائل، ثبِّت ميزة "تحقيق الربح" عليها جميعًا.
• أكمِل عملية الإعداد لتحقيق الربح في مؤسسات Edge.
• اضبط بوابة "خدمات المطوّرين" لإتاحة تحقيق الربح. لمزيد من المعلومات، يُرجى الاطّلاع على http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

إنشاء ملف إعداد صامت لتحقيق الربح

في ما يلي مثال على ملف إعداد صامت لتثبيت Monetization. عدِّل هذا الملف حسب الضرورة لضبط الإعدادات. استخدِم الخيار ‎-f في setup.sh لتضمين هذا الملف.

ملاحظة: عادةً ما تضيف هذه السمات إلى ملف الإعداد نفسه الذي استخدمته لتثبيت Edge، كما هو موضّح في تثبيت مكوّنات Edge على عقدة.

# 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. 
# 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 معلومات SMTP، أضِفها. تتطلّب ميزة "تحقيق الربح" خادم SMTP.
• في عملية تثبيت مركز بيانات واحد، يتم ضبط جميع عُقد ZooKeeper تلقائيًا على أنّها قادة. عند تثبيت Edge في مراكز بيانات متعددة، سيتم ضبط بعض عُقد ZooKeeper كمراقبين. تأكَّد من أنّ السمة 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. في حال تثبيت ميزة "تحقيق الربح" على عدة عُقد في خادم الإدارة، كرِّر الخطوة 2 على العقدة الثانية في خادم الإدارة.

عند نجاح عملية الضبط، يتم إنشاء مخطط RDBMS لخدمات تحقيق الربح في قاعدة بيانات PostgreSQL. بذلك تكتمل عملية دمج "خدمات تحقيق الربح" والمكوّنات المرتبطة بها مع خادم Postgres.

دمج خدمات تحقيق الربح مع جميع معالِجات الرسائل

استخدِم الإجراء التالي لدمج ميزة تحقيق الربح على جميع عُقد "معالج الرسائل".

1. في عقدة "معالج الرسائل" الأولى، شغِّل نص التهيئة البرمجي في موجه الأوامر:
   > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
   
   يحدِّد الخيار "‎-p mo" دمج ميزة "تحقيق الربح".
   
   يجب أن يكون ملف الإعداد متاحًا أو قابلاً للقراءة من قِبل مستخدم "apigee".
2. كرِّر هذا الإجراء على جميع عُقد "معالج الرسائل".

عند ضبط الإعدادات بنجاح، يتم تعديل "معالج الرسائل" باستخدام "خدمات تحقيق الربح". وبهذا تكتمل عملية دمج "خدمات تحقيق الربح" والمكوّنات المرتبطة بها مع "معالِجات الرسائل".

إعداد ميزة تحقيق الربح

لإنشاء مؤسسة جديدة تم تفعيل ميزة تحقيق الربح فيها، عليك أولاً إنشاء المؤسسة كما تفعل مع أي مؤسسة جديدة. لمزيد من المعلومات، يُرجى الاطّلاع على إعداد مؤسسة.

خطوات إعداد إضافية لتفعيل ميزة تحقيق الربح لمؤسسة

لإكمال عملية إعداد ميزة تحقيق الربح في مؤسسة، عليك تنفيذ ما يلي:

1. أنشئ مجموعة تحقيق الربح: mxgroup.
2. أضِف Qpid إلى المجموعة.
3. فعِّل ميزة تحقيق الربح للمؤسسة.
4. فعِّل إعدادات الإشعارات للمؤسسة.
5. كرِّر هذه العملية لجميع المؤسسات التي تريد تفعيل ميزة "تحقيق الربح" فيها.

استخدِم الأمر enable-monetization لتنفيذ كل هذه المهام. يستخدم هذا النص البرمجي ملف إعداد يحتوي على السمات التالية:

MSIP=IPorDNSofManagementServer
APIGEE_PORT_HTTP_MS=8080    # Default is 8080.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"
# Space-separated list IP/DNS names of all Qpid nodes in the data center being configured.
QPID_HOST="$IP6 $IP7"    
QPID_PORT=8083     # Default is 8083.
REGION=dc-1
ORG_NAME=myorg    # The Edge org where you want to enable monetization. 
MX_GROUP=mxgroup    # Default Monetization group.

ملاحظات:

• اضبط CASS_HOSTS وREGION على القيم نفسها التي استخدمتها عند تثبيت ميزة "تحقيق الربح".
• في حال تفعيل ميزة "تحقيق الربح" في إعدادات مراكز بيانات متعددة:
  • يجب تكرار عملية الإعداد على خادم الإدارة في كل مركز بيانات.
  • يجب أن يسرد ملف الإعداد عُقد Qpid فقط في مركز البيانات الذي يتم إعداده.

لتشغيل النص البرمجي:

1. استدعِ النص البرمجي:
   > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile
   
   يجب أن يكون ملف الإعداد متاحًا أو قابلاً للقراءة من قِبل مستخدم "apigee".
   
   إذا كانت لديك عدة خوادم إدارة، ما عليك سوى تشغيل هذا النص البرمجي على أحدها.
   
   ينسخ هذا النص البرمجي المؤسسة والمنتجات والمطوّرين والتطبيقات من قاعدة بيانات Cassandra إلى قاعدة بيانات PostgreSQL لتحقيق الربح. بعد تثبيت "خدمات تحقيق الربح" بنجاح، تتم مزامنة البيانات تلقائيًا.
2. كرِّر هذا الإجراء لكل مؤسسة تريد تفعيل ميزة "تحقيق الربح" فيها.
3. إذا كنت تستخدم بيئة مراكز بيانات متعددة، كرِّر هذه العملية على خادم الإدارة في مركز البيانات الآخر. تأكَّد من أنّ ملف الإعداد يسرد فقط عُقد Qpid في مركز البيانات الذي يتم ضبطه.

عند تسجيل الدخول إلى واجهة مستخدم Edge في المرة التالية، سيظهر لك إدخال "تحقيق الربح" في القائمة ذات المستوى الأعلى للمؤسسة:

ضبط إعدادات بوابة خدمات المطوّرين

لضبط بوابة "خدمات المطوّرين" لإتاحة تحقيق الربح، يُرجى الاطّلاع على http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

إضافة عقدة خادم إدارة إلى عملية تثبيت تحقيق الربح

إذا أضفت خادم إدارة إلى عملية تثبيت 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

تعرض ميزة "تحقيق الربح" مستندات الفوترة للمستخدمين النهائيين بتنسيق HTML. لتقديم مستندات الفوترة كملفات PDF، يمكنك دمج ميزة "تحقيق الربح" مع نظام فوترة يوفّر إمكانية إنشاء ملفات PDF أو ترخيص مكتبة PDF تابعة لجهة خارجية متوافقة.

ضبط إعدادات المؤسسة

إعدادات الخلفية: يسرد الجدول التالي سمات مستوى المؤسسة المتاحة لضبط مؤسسة Mint. يمكنك استخدام طلب PUT لإضافة هذه السمات أو تعديلها كما هو موضّح أدناه:

> curl -u ${ADMIN_EMAIL}:${ADMINPW} -v http://<management-ip>:8080/v1/organizations/{orgId} -d '{org object with attributes}' -X PUT

على سبيل المثال، ستبدو مخرجات أمر CURL أعلاه على النحو التالي:

{
...
    "displayName": "Orgnization name",
    "name": "org4",
    "properties": {
        "property": [
...
            {
                "name": "MINT_CURRENCY",
                "value": "USD"
            },
            {
                "name": "MINT_COUNTRY",
                "value": "US"
            },
            {
                "name": "MINT_TIMEZONE",
                "value": "GMT"
            }
        ]
    }
}

لضبط إعدادات المؤسسة التجارية باستخدام واجهة مستخدم الإدارة، يُرجى الاطّلاع على http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.

ملاحظة: إذا كنت تستخدم ميزتَي "حدود خدمات تحقيق الربح" و"الإشعارات"، يُرجى توجيه المطوّرين إلى إرفاق "سياسة الحدّ" في مسار الوكيل بعد سياسة التحقّق من صحة رمز الدخول.

"سياسة الحدّ الأقصى" هي سياسة صريحة مصمَّمة لحظر طلب بيانات من واجهة برمجة التطبيقات في حال بلوغ حدّ أقصى معيّن. تتحقّق السياسة من حدود النشاط التجاري وتُظهر خطأ في حال تجاوز أي حدود للقيمة التي تم ضبطها. هذا امتداد لسياسة رفع الأخطاء، ولكن يتم اشتقاق الشروط من متغيّرات النشاط التجاري.

يتوفّر نموذج واجهة مستخدم في واجهة مستخدم الإدارة لمطوّري الخوادم الوكيلة. يجب على مطوّر الخادم الوكيل إرفاق سياسة mint في مسار الرسالة. عند تنفيذ هذه السياسة، سيتم إرسال الخطأ مع استجابة الخطأ وفقًا للسياسة. إذا تم ضبط ContinueOnError على "صحيح"، لن يتم رفع الخطأ وسيتم ضبط متغيرات التدفق "mint.limitsViolated" و"mint.isDeveloperSuspended" و"mint.limitsPolicyError" التي يمكن استخدامها لمزيد من معالجة الاستثناءات إذا لزم الأمر.