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

Edge for Private Cloud الإصدار 4.19.01

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

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

  • إذا كنت تريد تثبيت ميزة "تحقيق الربح" على مخطط Edge الذي يستخدم عُقد خادم الإدارة المتعددة، مثل تثبيت 13 عقدة، يجب تثبيت كلتا عُقد خادم إدارة Edge قبل تثبيت تحقيق الربح.
  • لتثبيت عُقد Postgres في حال كان تثبيت Edge يحتوي على عُقد متعدّدة في Postgres، يجب ضبط عُقد Postgres في وضع "الرئيسي" و"وضع الاستعداد". لا يمكنك تثبيت ميزة "تحقيق الربح" على Edge إذا كانت لديك عدة عُقد رئيسية في Postgres. لمزيد من المعلومات، يُرجى الاطّلاع على إعداد النسخ المماثل لوضع الاستعداد لشركة Postgres.
  • لا تتوفر ميزة تحقيق الربح مع إعدادات "الشاملة" (AIO).

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

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

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

    إذا كانت لديك عُقد متعددة لخادم الإدارة، مثل تثبيت 13 عقدة، يجب تثبيت عُقد خادم إدارة Edge قبل تثبيت تحقيق الربح.

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

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

في ما يلي مثال على ملف ضبط صامت لعملية تثبيت تحقّق الربح. عدِّل هذا الملف حسب الضرورة لعملية الضبط. استخدِم الخيار -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.
# 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

دمج خدمات تحقيق الربح مع جميع خوادم الإدارة

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

  1. إذا كنت تريد تثبيت ميزة تحقيق الربح على مخطط Edge الذي يستخدم عُقد خادم الإدارة المتعددة، مثل تثبيت 13 عقدة، يجب التأكد من تثبيت كلتا عُقدتي خادم الإدارة قبل تثبيت تحقيق الربح.
  2. في عقدة خادم الإدارة، شغِّل النص البرمجي للإعداد:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

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

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

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

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

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

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

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

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

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

  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

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

القيم المقبولة هي "تم الإلغاء"، و"غير متاح"، و"HYBRID" (القيمة التلقائية هي فارغة).
MINT_CURRENCY

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

الوجود الضريبي في الضرائب (القيمة التلقائية هي قيمة فارغة)
MINT_DEFAULT_PROD_TAX_CATEGORY

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

تنظيم مجموعة نسبة ظهور الإعلان (القيمة التلقائية هي "خطأ")
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

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

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

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

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

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

الحدود القصوى المسموح بها لتحقيق الربح

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

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

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

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