Edge for Private Cloud 4.16.05
تشكّل Monetization Services إضافة إضافية في Apigee Edge، لذلك لا يتم تشغيلها كمنصة مستقلة. الدفع. ويتم تشغيله ضمن أي إعداد حالي لخدمة Apigee Edge.
متطلبات تحقيق الربح
- في حال تثبيت ميزة "تحقيق الربح" على مخطط Edge الذي يستخدم "خادم إدارة" متعدد مثل تثبيت 13 عقدة، فيجب عليك تثبيت كل من عقد خادم إدارة Edge قبل تثبيت ميزة "تحقيق الربح"
- لتثبيت ميزة "تحقيق الربح" على Edge حيث يتضمّن تثبيت Edge عدة عقد Postgres، يجب ضبط عقد Postgres في وضع "الرئيسي/الاحتياطي". لا يمكنك تثبيت ميزة "تحقيق الربح" على Edge إذا كانت لديك عدة عقد رئيسية في Postgres. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة إعداد ميزة "النسخ الاحتياطي للمثيل الرئيسي" لقاعدة بيانات Postgres.
نظرة عامة على عملية التركيب
توضّح الخطوات التالية كيفية إضافة "خدمات تحقيق الربح" على إصدار حالي في Apigee Edge. التثبيت:
- استخدِم الأداة apigee-setup
لتعديل عقدة "خادم إدارة Apigee" لتفعيل "خدمات تحقيق الربح"، مثلاً إدارة القائمة وضبط الحدود والإشعارات والفوترة
وإعداد التقارير.
إذا كان لديك عُقد متعددة لخادم الإدارة، مثل تثبيت مكوّن من 13 عقدة، يجب عليك تثبيت عُقدتَي خادم إدارة Edge قبل تثبيت "تحقيق الربح". - استخدام apigee-setup لتحديث Apigee Message Processor (معالج رسائل Apigee) لتفعيل مكوّنات بيئة التشغيل خدمات تحقيق الربح، مثل سياسة تسجيل المعاملات وإجراءات فرض القيود إذا كنت لدى العديد من معالجات الرسائل، يمكنك تثبيت "تحقيق الربح" عليها جميعًا.
- نفِّذ عملية إعداد "تحقيق الربح" لمؤسسات Edge.
- ضبط بوابة "خدمات المطوّرين" لتفعيل ميزة تحقيق الربح لمزيد من المعلومات، يُرجى مراجعة http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.
إنشاء ملف إعدادات صامت لميزة تحقيق الربح
في ما يلي مثال على ملف إعدادات صامت لتثبيت ميزة "تحقيق الربح". تعديل هذا بالشكل اللازم لإجراء التهيئة. استخدِم الخيار -f لإعداد setup.sh لتضمين هذا الملف.
ملاحظة: يمكنك عادةً إضافة هذه الخصائص إلى ملف الإعداد نفسه الذي الذي استخدمته لتثبيت Edge، كما هو موضح في Install 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ملاحظات:
- إذا لم يحدِّد ملف إعدادات Edge معلومات SMTP، أضِفها. تتطلّب تحقيق الربح استخدام خادم SMTP.
- في عملية تثبيت مركز بيانات واحد، يتم ضبط جميع عقد ZooKeeper تلقائيًا على أنّها رؤساء. عند تثبيت Edge عبر مراكز بيانات متعددة، ستتغير بعض عُقد ZooKeeper كمراقبين. تأكد من أن الخاصية ZK_HOSTS أعلاه تحدد عقدة أولية في تثبيت مركز بيانات متعدد.
- في حال تفعيل مصادقة Cassandra، يمكنك ضبط اسم المستخدم وكلمة المرور لـ Cassandra.
باستخدام السمات التالية:
CASS_USERNAME
CASS_PASSWORD
دمج خدمات تحقيق الربح مع جميع خوادم الإدارة
استخدِم الإجراء التالي لدمج ميزة تحقيق الربح في عقد "خادم الإدارة".
- إذا كنت بصدد تثبيت ميزة "تحقيق الربح" على بنية Edge تستخدِم عدّة عقد "خادم إدارة"، مثل عملية تثبيت تتضمّن 13 عقدة، تأكَّد من تثبيت كلتا عقدتَي "خادم الإدارة" قبل تثبيت ميزة "تحقيق الربح".
- في عقدة "خادم الإدارة"، شغِّل النص البرمجي للإعداد:
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
يحدّد الخيار " -p mo" خيار دمج "تحقيق الربح".
يجب أن يكون ملف الإعداد قابلاً للوصول أو القراءة بواسطة "apigee" المستخدم. على سبيل المثال، يمكنك وضع الملف في الدليل /tmp على العقدة. - في حال تثبيت ميزة "تحقيق الربح" على عدة عُقد في "خادم الإدارة"، كرِّر الخطوة 2 في العقدة الثانية لخادم الإدارة.
عند نجاح عملية الضبط، يتم إنشاء مخطّط لنظام إدارة قواعد البيانات العلائقية (RDBMS) لخدمات تحقيق الربح في قاعدة بيانات PostgreSQL. يُكمِل هذا الإجراء عملية دمج "خدمات تحقيق الربح" ومكوناتها المرتبط بها مع خادم Postgres.
دمج خدمات تحقيق الربح مع جميع معالجات الرسائل
استخدِم الإجراء التالي لدمج تحقيق الربح في جميع العقد المتعلّقة بمعالج الرسائل .
- في عقدة Message Processor الأولى، في موجّه الأوامر، شغِّل نص إعدادات الربط:
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
يحدّد الخيار "-p mo" دمج ميزة تحقيق الربح.
يجب أن يكون بإمكان مستخدم "apigee" الوصول إلى ملف الإعدادات أو قراءته. على سبيل المثال، يمكنك وضع الملف في الدليل /tmp على العقدة. - كرِّر هذا الإجراء على جميع عقد Message Processor.
عند نجاح عملية الإعداد، يتم تعديل "معالج الرسائل" باستخدام "خدمات تحقيق الربح". يُكمِل ذلك عملية دمج "خدمات تحقيق الربح" والمكوّنات المرتبطة بها مع "معالجي" الرسائل.
إعداد ميزة تحقيق الربح
لإنشاء مؤسسة جديدة مع تفعيل ميزة تحقيق الربح، عليك أولاً إنشاء المؤسسة كما هو الحال مع أي مؤسسة جديدة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة إعداد مؤسسة.
عملية إعداد إضافية لتفعيل ميزة "تحقيق الربح" للمؤسسة
لإكمال عملية إعداد ميزة تحقيق الربح في مؤسّسة، يجب:
- أنشِئ مجموعة تحقيق الربح: 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 و REGION على القيم نفسها التي استخدمتها عند تثبيت ميزة "تحقيق الربح".
- في حال تفعيل ميزة "تحقيق الربح" في إعداد مركز بيانات متعدّد:
- عليك تكرار عملية الإعداد في "خادم الإدارة" في كل بيانات. الأوسط.
- يجب أن يدرج ملف التهيئة فقط عقد Qpid في مركز البيانات الذي يجري تكوينه.
لتشغيل النص البرمجي:
- استدعاء النص البرمجي:
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile
يجب أن يكون بإمكان مستخدم "apigee" الوصول إلى ملف الإعداد أو قراءته. على سبيل المثال، يمكنك وضع الملف في الدليل /tmp على العقدة.
إذا كانت لديك عدة خوادم إدارة، يجب تشغيل هذا النص البرمجي على أحدها فقط.
يعمل هذا النص البرمجي على نسخ بيانات المؤسسة والمنتجات والمطوّرين والتطبيقات من قاعدة بيانات 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 restart - على "خادم الإدارة" الجديد، أدخِل ما يلي:
> /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 restart
إعدادات إضافية
تقديم مستندات الفوترة باسم ملفات 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 |
القيم المقبولة هي "تجاهل"، UNDISCLOSED أو HYBRID (القيمة التلقائية هي null) |
MINT_CURRENCY |
رمز العملة وفقًا لمعايير ISO (القيمة التلقائية هي "خالية") |
MINT_TAX_NEXUS |
مكان إقامتك الضريبية (القيمة التلقائية هي "غير محدّد") |
MINT_DEFAULT_PROD_TAX_CATEGORY |
فئة الضريبة التلقائية للمنتج (القيمة التلقائية هي null) |
MINT_IS_GROUP_ORG |
مؤسسة مجموعة IS (القيمة التلقائية هي false) |
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 |
يشير إلى ما إذا كان يجب إصدار بيان التسوية (القيمة التلقائية هي false) |
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 |
تُستخدَم هذه الوظيفة في واجهة مستخدم الإدارة لعرض الموفّر على أنّه مؤسسة Operator verses Organization. (القيمة التلقائية هي true) |
لضبط إعدادات مؤسسة النشاط التجاري باستخدام واجهة المستخدم للإدارة، يُرجى الاطّلاع على http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.
ملاحظة: في حال استخدام حدود "خدمات تحقيق الربح" وإشعاراتها يُرجى توجيه المطورين لديك لإرفاق سياسة حدود في مسار الخادم الوكيل بعد سياسة التحقق من رمز الدخول.
"سياسة الحدود" هي سياسة صريحة مصمّمة لحظر طلب بيانات من واجهة برمجة التطبيقات في حال تمّ الوصول إلى حدّ معيّن. تتحقّق السياسة من حدود النشاط التجاري وتُبلغ عن خطأ في حال توفّر أي حدود تتجاوز القيمة التي تم ضبطها. هذه إضافة إلى سياسة خطأ الزيادة، ولكن الشروط مشتقة. من متغيرات الأعمال.
يتوفّر نموذج واجهة مستخدم في واجهة مستخدم الإدارة للمطوّرين الوكيلين. يجب على مطور الخادم الوكيل إرفاق سياسة الأدوات في مسار الرسالة بعد تنفيذ هذه السياسة، سيتم توضيح الخطأ. مع الاستجابة للخطأ وفقًا للسياسة. في حال ضبط ContinueOnError على "صحيح"، يكون الخطأ لن يتم رفع متغيرات التدفق "mint.limitsViolated"، وmint.isDeveloperComment". و"mint.limitsPolicyError" سيتم تعيين المتغيرات والتي يمكن استخدامها للتعامل مع الاستثناءات بشكل إضافي إذا لزم الأمر.