Edge for Private Cloud - الإصدار 4.17.09
تُعدّ "خدمات تحقيق الربح" امتدادًا لخدمة Apigee Edge، وبالتالي لا يتم تشغيلها كعملية مستقلة. ويتم تشغيله ضمن أي إعداد حالي في Apigee Edge.
متطلبات تحقيق الربح
- إذا كنت تريد تثبيت ميزة "تحقيق الربح" على بنية Edge التي تستخدم عُقد خادم الإدارة المتعددة، مثل تثبيت 13 عقدة، يجب تثبيت كلتا عُقد خادم إدارة Edge قبل تثبيت تحقيق الربح.
- لتثبيت عُقد Postgres في حال كان تثبيت 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.
إنشاء ملف إعداد صامت لتحقيق الربح
في ما يلي مثال على ملف ضبط صامت لعملية تثبيت تحقّق الربح. عدِّل هذا الملف حسب الضرورة لعملية الضبط. استخدِم الخيار -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
دمج خدمات تحقيق الربح مع جميع خوادم الإدارة
استخدم الإجراء التالي لدمج تحقيق الربح في عُقد Management Server.
- إذا كنت تريد تثبيت ميزة تحقيق الربح على مخطط Edge الذي يستخدم عُقد خادم الإدارة المتعددة، مثل تثبيت 13 عقدة، يجب التأكد من تثبيت كلتا عُقدتي خادم الإدارة قبل تثبيت تحقيق الربح.
- في عقدة Management Server، شغِّل النص البرمجي للإعداد:
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
يُحدّد الخيار "-p mo" لدمج ميزة تحقيق الربح.
يجب أن يتمكّن مستخدم "واجهة برمجة التطبيقات" من الوصول إلى ملف الإعداد أو قراءته. - إذا كنت تثبِّت ميزة تحقيق الربح على عدة عُقد في خادم الإدارة، كرِّر الخطوة 2 في عقدة خادم الإدارة الثانية.
عند الضبط الناجح، يتم إنشاء مخطّط RDBMS لخدمات تحقيق الربح في قاعدة بيانات PostgreSQL. تكتمل هذه العملية دمج خدمات تحقيق الربح والمكوّنات المرتبطة بها مع خادم Postgres.
دمج خدمات تحقيق الربح مع جميع معالجات الرسائل
اتّبِع الإجراء التالي لدمج ميزة تحقيق الربح في جميع عُقد معالج الرسائل.
- في عقدة "معالج الرسائل" الأولى، شغِّل النص البرمجي للإعداد في موجّه الأوامر:
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
يُحدد الخيار "-p mo" لدمج ميزة تحقيق الربح.
يجب أن يتمكّن مستخدم "واجهة برمجة التطبيقات" من الوصول إلى ملف الإعداد أو قراءته. - كرر هذا الإجراء على جميع عُقد معالج الرسائل.
عند الضبط الناجح، يتم تعديل "معالج الرسائل" إلى "خدمات تحقيق الربح". تكتمل هذه العملية دمج خدمات تحقيق الربح والمكوّنات المرتبطة بها مع معالِجات الرسائل.
إعداد ميزة تحقيق الربح
لإنشاء مؤسسة جديدة مع تفعيل ميزة تحقيق الربح فيها، عليك أولاً إنشاء المؤسسة كما تفعل مع أي مؤسسة جديدة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة منح إمكانيّة الوصول إلى مؤسسة.
إعداد إضافي لتفعيل ميزة "تحقيق الربح" في مؤسسة
لإكمال إعداد ميزة تحقيق الربح في مؤسسة، عليك تنفيذ ما يلي:
- أنشئ مجموعة تحقيق الربح: mxgroup.
- أضف Qpid إلى المجموعة.
- تفعيل ميزة تحقيق الربح للمؤسسة
- تفعيل إعدادات الإشعارات للمؤسسة
- كرِّر هذه العملية لجميع المؤسسات التي تريد تفعيل ميزة تحقيق الربح فيها.
استخدِم الأمر 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 والمنطقة على القيم نفسها التي استخدمتها عند تثبيت ميزة "تحقيق الربح".
- في حال تفعيل ميزة "تحقيق الربح" في إعدادات متعددة لمركز بيانات:
- ويجب تكرار عملية الإعداد على "خادم الإدارة" في كل مركز بيانات.
- يجب أن يسرد ملف الإعداد عُقد Qpid فقط في مركز البيانات الذي يتم إعداده.
لتشغيل النص البرمجي:
- استدعِ النص البرمجي:
> /opt/apigee/apigee-service/bin/apigee-service apigee-provisionenable-monetization -f configFile
يجب أن يكون مستخدم "apigee" قادرًا على الوصول إلى ملف الإعداد أو قراءته.
إذا كنت تمتلك خوادم إدارة متعددة، عليك تشغيل هذا النص البرمجي على أحدها فقط.
ينسخ هذا النص البرمجي المؤسسة والمنتجات والمطوّرين والتطبيقات من قاعدة بيانات Cassandra إلى قاعدة بيانات تحقيق الربح المادي من PostgreSQL. بعد التثبيت الناجح لخدمات تحقيق الربح، تتم مزامنة البيانات تلقائيًا. - كرِّر هذا الإجراء لكل مؤسسة تريد تفعيل ميزة تحقيق الربح فيها.
- إذا كنت في بيئة متعدّدة لمركز البيانات، يمكنك تكرار هذه العملية على "خادم الإدارة" في مركز البيانات الآخر. تأكَّد من أنّ ملف الإعداد يدرج فقط عُقد Qpid في مركز البيانات الذي يتم إعداده.
عند تسجيل الدخول في المرة التالية إلى واجهة مستخدم Edge، سيظهر لك إدخال "تحقيق الربح" في قائمة المستوى الأعلى للمؤسسة:
ضبط بوابة "خدمات المطوِّرين"
لضبط بوابة خدمات المطوّرين لدعم تحقيق الربح، يُرجى الاطّلاع على http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.
إضافة عقدة خادم الإدارة إلى عملية تثبيت لتحقيق الربح
إذا أضفت خادم إدارة إلى تثبيت Edge الحالي، يجب التأكد من إضافة خدمات تحقيق الربح إلى خادم الإدارة الجديد وإعداد جميع خوادم الإدارة حتى يمكنها الاتصال.
لإضافة خادم إدارة:
- ثبِّت خادم الإدارة الجديد.
- ثبِّت ميزة تحقيق الربح على خادم الإدارة الجديد.
- في خادم الإدارة الأصلي، استدعِ ما يلي:
> /opt/apigee/apigee-service/bin/apigee-service Edge-mint-management-server mint-configure-mgmt-cluster - أعِد تشغيل خادم الإدارة الأصلي:
> /opt/apigee/apigee-service/bin/apigee-service Edge-management-server إعادة تشغيل - في خادم الإدارة الجديد، استدعِ ما يلي:
> /opt/apigee/apigee-service/bin/apigee-service Edge-mint-management-server mint-configure-mgmt-cluster - أعِد تشغيل خادم الإدارة الجديد:
> /opt/apigee/apigee-service/bin/apigee-service Edge-management-server إعادة تشغيل
الإعدادات الإضافية
تقديم مستندات الفوترة كملفات PDF
تعرِض ميزة تحقيق الربح مستندات الفوترة للمستخدمين النهائيين بتنسيق HTML. لتقديم مستندات الفوترة كملفات PDF، يمكنك دمج تحقيق الربح المادي مع نظام فوترة يتيح إنشاء ملفات PDF أو ترخيص مكتبة PDF متوافقة تابعة لجهة خارجية.
ضبط إعدادات المؤسسة
إعدادات الخلفية: يسرد الجدول التالي السمات على مستوى المؤسسة المتاحة لضبط مؤسسة سك. يمكنك استخدام طلب 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"
}
]
}
}
|
السمات |
الوصف |
|---|---|
|
MINT_TAX_MODEL |
القيم المقبولة هي "مُفصَّلة"، غير مغلق، مختلط (القيمة التلقائية هي قيمة فارغة) |
|
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 |
تشير هذه السمة إلى ما إذا كانت المؤسسة تستخدم فاتورة منفصلة لكل منتج (القيمة التلقائية هي "خطأ"). |
|
MINT_HAS_BILLING_ADJUSTMENT |
يشير إلى ما إذا كانت المؤسسة تدعم تسويات رصيد الحساب (القيمة التلقائية هي "خطأ") |
|
features.isMonetizationEnabled |
يتم استخدامه من قِبل واجهة مستخدم الإدارة لعرض قائمة محددة لتحقيق الربح (القيمة التلقائية هي "خطأ") |
|
ui.config.isOperator |
يتم استخدامه من قِبل واجهة مستخدم الإدارة لعرض مقدّم الخدمة على أنّه عامل التشغيل كمؤسسة. (القيمة التلقائية هي true) |
لضبط إعدادات تنظيم النشاط التجاري باستخدام واجهة مستخدم الإدارة، يُرجى الاطّلاع على http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.
ملاحظة: إذا كنت تستخدم ميزات "الحدود القصوى المسموح بها" و"الإشعارات" في خدمات تحقيق الربح، يُرجى توجيه المطوّرين لإرفاق "سياسة حدود" في مسار الخادم الوكيل بعد انتهاء سياسة إثبات صحة رمز الدخول.
"سياسة الحدود" هي سياسة واضحة مصمَّمة لحظر طلب البيانات من واجهة برمجة التطبيقات في حال بلوغ حدّ معيّن. تتحقّق السياسة من الحدود القصوى للأنشطة التجارية وتُظهر حدوث خطأ في حال كانت هناك أي حدود تتجاوز القيمة التي تم ضبطها. هذه امتداد لسياسة زيادة الأخطاء، ولكنّ الشروط مشتقة من متغيّرات النشاط التجاري.
يتوفّر نموذج واجهة مستخدم في واجهة مستخدم الإدارة لمطوّري البرامج الوكيلة. على مطوّر الوكيل إرفاق سياسة mint في مسار الرسالة. وعند تنفيذ هذه السياسة، سيظهر الخطأ مع الاستجابة للخطأ وفقًا للسياسة. في حال ضبط ContinueOnError على "صحيح"، لن يتم عرض الخطأ، وسيتم ضبط متغيّرات التدفق "mint.limitsViolated" و"mint.isDevelopersuspended" و"mint.limitsPolicyError"، مع العلم بأنّه يمكن استخدام هذه المتغيّرات لمعالجة الاستثناءات الإضافية إذا لزم الأمر.