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

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

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

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

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

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

  • استخدِم الأداة apigee-setup لتعديل عقدة "خادم إدارة Apigee" لأجل تفعيل "خدمات تحقيق الربح"، مثل إدارة القائمة والحدود والإشعارات وإعداد الفوترة وإعداد التقارير.

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

  • استخدِم أداة apigee-setup لتعديل "معالج رسائل Apigee" لتفعيل مكوّنات وقت التشغيل في خدمات تحقيق الربح، مثل سياسة تسجيل المعاملات وفرض الحدود. إذا كان لديك عدّة تطبيقات لمعالجة الرسائل، ثبِّت ميزة "تحقيق الربح" على جميعها.
  • نفِّذ عملية إعداد ميزة تحقيق الربح لمؤسساتك في 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, 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 معلومات بروتوكول SMTP، أضِفها. تتطلب ميزة تحقيق الربح خادم SMTP.
  • في عملية تثبيت واحدة لمركز بيانات، يجب ضبط الأعداد الفردية من عُقد 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. في حال تثبيت ميزة "تحقيق الربح" على عدة عُقد في خادم الإدارة، كرِّر الخطوة 2 على عقدة خادم الإدارة الثانية.

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

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

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

  1. في عقدة Message Processor الأولى، في موجِّه الأوامر، شغِّل نص إعدادات الربط: 
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    يحدّد الخيار -p mo دمج ميزة "تحقيق الربح".

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

  2. كرر هذا الإجراء على جميع عُقد معالج الرسائل.

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

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

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

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

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

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

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

في حال إضافة "خادم إدارة" إلى عملية تثبيت حالية من Edge، عليك التأكّد من إضافة خدمات UME إلى "خادم الإدارة" الجديد وضبط جميع "خوادم الإدارة" لكي تتمكّن من التفاعل مع بعضها.

لإضافة خادم إدارة:

  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 متوافقة تابعة لجهة خارجية.

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

لإضافة/تعديل سمات المؤسسة، يمكنك استخدام طلب 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.

السمات الوصف
MINT_TAX_MODEL

القيم المقبولة هي "DISCLOSED" و"UNDISCLOSED" و"HYBRID" (القيمة التلقائية هي null)
MINT_CURRENCY

رمز العملة وفقًا لمعيار ISO (القيمة التلقائية هي "قيمة فارغة")
MINT_TAX_NEXUS

مكان إقامتك الضريبية (القيمة التلقائية هي "غير محدّد")
MINT_DEFAULT_PROD_TAX_CATEGORY

فئة الضريبة التلقائية المفروضة على المنتج (القيمة التلقائية هي فارغة)
MINT_IS_GROUP_ORG

مؤسسة مجموعة IS (القيمة التلقائية هي "false")
MINT_HAS_BROKER

تم إيقافه (القيمة التلقائية هي false)
MINT_TIMEZONE

المنطقة الزمنية (القيمة التلقائية هي null)
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

يشير إلى ما إذا كان يجب إنشاء فاتورة رسوم منفصلة (القيمة التلقائية هي "false")
MINT_ISSUE_NETTING_STMT

يشير إلى ما إذا كان يجب إصدار بيان التسوية (القيمة التلقائية هي "false")
MINT_NETTING_STMT_PER_CURRENCY

تشير إلى ما إذا كان يجب إنشاء بيان التسوية لكل عملة (القيمة التلقائية هي "false").
MINT_HAS_SELF_BILLING

يشير إلى ما إذا كانت المؤسسة تستخدم نظام الفوترة الذاتي (القيمة التلقائية هي "خطأ").
MINT_SELF_BILLING_FOR_ALL_DEV

تشير إلى ما إذا كانت المؤسسة تستخدم نظام الفوترة الذاتية لجميع المطوّرين (القيمة التلقائية هي "false")
MINT_HAS_SEPARATE_INV_FOR_PROD

تشير إلى ما إذا كانت المؤسسة لديها فاتورة منفصلة لكل منتج (القيمة التلقائية هي "false")
MINT_HAS_BILLING_ADJUSTMENT

تشير إلى ما إذا كانت المؤسسة تسمح بتسويات رصيد الحساب (القيمة التلقائية هي "خطأ").
features.isMonetizationEnabled

تُستخدَم واجهة المستخدم الخاصة بالإدارة لعرض قائمة خاصة بتحقيق الربح (القيمة التلقائية هي "false").
ui.config.isOperator

تُستخدَم هذه السمة من قِبل واجهة مستخدِم الإدارة لعرض مقدّم الخدمة على أنّه مشغّل بدلاً من مؤسسة (القيمة التلقائية هي "صحيح").

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

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

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

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

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

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