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

‫Monetization Services هي إضافة إلى Apigee Edge، لذا لا يتم تشغيلها كعملية مستقلة. يتم تشغيلها ضمن أي عملية إعداد حالية في Apigee Edge، باستثناء إعداد All-In-One (AIO) لا يمكنك تثبيت Monetization Services على إعداد AIO.

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

• إذا كنت تثبّت ميزة تحقيق الربح على طوبولوجيا Edge تستخدم عدة عُقد Management Server ، مثل عملية تثبيت تتضمّن 13 عُقدة، عليك تثبيت كلتا عُقدتَي Edge Management Server قبل تثبيت ميزة تحقيق الربح.
• لتثبيت ميزة تحقيق الربح على Edge حيث يتضمّن إعداد Edge عدة عُقد Postgres، يجب ضبط عُقد Postgres في وضع Master/Standby. لا يمكنك تثبيت ميزة تحقيق الربح على Edge إذا كانت لديك عدة عُقد رئيسية في Postgres. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة إعداد عملية النسخ المتماثل في وضع Master-Standby لـ Postgres.
• لا تتوفّر ميزة تحقيق الربح مع إعداد All-In-One (AIO).

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

توضّح الخطوات التالية كيفية إضافة Monetization Services على عملية تثبيت حالية في Apigee Edge:

• استخدِم الأداة apigee-setup لتعديل عُقدة Apigee Management Server من أجل تفعيل Monetization Services، مثل إدارة الفهرس وإعداد الحدود والإشعارات والفوترة وإعداد التقارير.

  إذا كانت لديك عدة عُقد Management Server، مثل عملية تثبيت تتضمّن 13 عُقدة، عليك تثبيت كلتا عُقدتَي Edge Management Server قبل تثبيت ميزة تحقيق الربح.

• استخدِم الأداة apigee-setup لتعديل Apigee Message Processor من أجل تفعيل مكوّنات وقت التشغيل في Monetization Services، مثل سياسة تسجيل المعاملات وفرض الحدود. إذا كانت لديك عدة معالِجات رسائل، ثبِّت ميزة تحقيق الربح على جميعها.
• نفِّذ عملية إعداد ميزة تحقيق الربح لمؤسساتك على Edge.
• اضبِط إعدادات بوابة Apigee Developer Services (أو ببساطة البوابة) لدعم تحقيق الربح. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة ضبط إعدادات تحقيق الربح في بوابة مخصّصة للمطوّرين.

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

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

# Edge configuration properties
# Specify IP address or DNS name of node.
IP1=192.168.1.1  # Management Server, SymasLDAP, New Edge 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 معلومات SMTP، أضِفها. تتطلّب ميزة تحقيق الربح خادم SMTP.
• في عملية تثبيت مركز بيانات واحد، يتم تلقائيًا ضبط جميع عُقد ZooKeeper كعُقد رئيسية. عند تثبيت Edge على عدة مراكز بيانات، سيتم ضبط بعض عُقد ZooKeeper كـ مراقبين. تأكَّد من أنّ السمة ZK_HOSTS أعلاه تحدِّد عُقدة رئيسية في عملية تثبيت تتضمّن عدة مراكز بيانات.
• إذا فعّلت عملية المصادقة في Cassandra، يمكنك تمرير اسم مستخدم Cassandra وكلمة المرور باستخدام الخصائص التالية:

  CASS_USERNAME
  CASS_PASSWORD

دمج Monetization Services مع جميع خوادم الإدارة

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

1. إذا كنت تثبّت ميزة تحقيق الربح على طوبولوجيا Edge تستخدم عدة عُقد Management Server ، مثل عملية تثبيت تتضمّن 13 عُقدة، تأكَّد من تثبيت كلتا عُقدتَي Management Server قبل تثبيت ميزة تحقيق الربح.
2. على عُقدة Management Server، شغِّل نص الإعداد:
   

   /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

   يشير الخيار ‎-p mo إلى دمج ميزة تحقيق الربح.

   يجب أن يكون ملف الإعداد قابلاً للوصول إليه أو قراءته من قِبل المستخدم "apigee".

3. إذا كنت تثبّت ميزة تحقيق الربح على عدة عُقد Management Server، كرِّر الخطوة 2 على عُقدة Management Server الثانية.

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

دمج Monetization Services مع جميع معالِجات الرسائل

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

1. على عُقدة Message Processor الأولى، في موجه الأوامر، شغِّل نص التهيئة البرمجي:

   /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

   يشير الخيار ‎-p mo إلى دمج ميزة تحقيق الربح.

   يجب أن يكون ملف الإعداد قابلاً للوصول إليه أو قراءته من قِبل المستخدم "apigee".

2. كرِّر هذا الإجراء على جميع عُقد Message Processor.

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

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

لإنشاء مؤسسة جديدة وتفعيل ميزة تحقيق الربح:

1. أنشِئ المؤسسة كما تفعل مع أي مؤسسة جديدة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة إعداد مؤسسة.
2. استخدِم واجهة برمجة التطبيقات لتوفير ميزة تحقيق الربح كما هو موضّح في تفعيل ميزة تحقيق الربح لمؤسسة. لإجراء ذلك، يجب أن تكون لديك امتيازات مشرف النظام.

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

لضبط البوابة لدعم تحقيق الربح، يُرجى الاطّلاع على مقالة ضبط إعدادات تحقيق الربح في بوابة مخصّصة للمطوّرين.

إضافة عُقدة Management Server إلى عملية تثبيت ميزة تحقيق الربح

إذا أضفت Management Server إلى عملية تثبيت حالية في Edge، عليك التأكّد من إضافة Monetization Services إلى Management Server الجديد وضبط جميع خوادم الإدارة لكي تتمكّن من التواصل مع بعضها.

لإضافة Management Server، اتّبِع الخطوات التالية:

1. ثبِّت عُقدة Management Server الجديدة.
2. ثبِّت ميزة تحقيق الربح على عُقدة Management Server الجديدة باستخدام الأمر التالي:

   /opt/apigee/apigee-setup/bin/setup.sh -p mo -f /opt/silent.conf

الإعدادات الإضافية

توفير مستندات الفوترة كملفات PDF

تعرض ميزة تحقيق الربح مستندات الفوترة للمستخدمين النهائيين بتنسيق HTML. لتوفير مستندات الفوترة كملفات 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.

لضبط إعدادات مؤسسة تجارية باستخدام واجهة مستخدم New Edge، يُرجى الاطّلاع على مقالة بدء استخدام ميزة تحقيق الربح.

حدود تحقيق الربح

لفرض حدود تحقيق الربح، عليك إرفاق سياسة التحقّق من حدود تحقيق الربح بخوادم واجهة برمجة التطبيقات الوكيلة. على وجه التحديد، يتم تفعيل السياسة في الحالات التالية:

• المطوّر الذي يصل إلى واجهة برمجة تطبيقات لتحقيق الربح غير مسجَّل أو لم يشترك في خطة الأسعار.
• تجاوز المطوّر حجم المعاملات لخطة الأسعار التي اشترك فيها.
• تم بلوغ رصيد حساب المطوّر المدفوع مسبقًا أو الحدّ الائتماني المدفوع لاحقًا.

تؤدي سياسة التحقّق من حدود تحقيق الربح إلى ظهور أخطاء وحظر طلبات بيانات من واجهة برمجة التطبيقات في حالات مثل الحالات المذكورة أعلاه. توسّع هذه السياسة سياسة Raise Fault، ويمكنك تخصيص الرسالة المعروضة. يتم استخلاص الشروط السارية من متغيّرات المؤسسة.

لمزيد من المعلومات، يُرجى الاطّلاع على مقالة فرض حدود تحقيق الربح على خوادم واجهة برمجة التطبيقات الوكيلة.