درحال نصب سرویس‌های درآمدزایی

«خدمات درآمدزایی» افزونه‌ای برای Apigee Edge است، بنابراین به‌عنوان فرایند مستقل اجرا نمی‌شود. این ویژگی در هر تنظیم Apigee Edge موجودی اجرا می‌شود، به‌جز پیکربندی «همه در یک» (AIO). نمی‌توانید «خدمات درآمدزایی» را در پیکربندی AIO نصب کنید.

الزامات درآمدزایی

  • اگر درحال نصب «درآمدزایی» روی توپولوژی Edge هستید که از چندین گره «سرور مدیریت» استفاده می‌کند، مثل نصب ۱۳ گره‌ای، باید قبل‌از نصب «درآمدزایی»، هر دو گره «سرور مدیریت Edge» را نصب کنید.
  • برای نصب «درآمدزایی» در Edge که نصب Edge دارای چندین گره Postgres است، گره‌های Postgres باید در حالت «اصلی/آماده به‌کار» پیکربندی شوند. اگر چند گره اصلی Postgres داشته باشید، نمی‌توانید «درآمدزایی» را در Edge نصب کنید. برای اطلاعات بیشتر، راه‌اندازی تکثیر «اصلی-آماده به کار» برای Postgres را ببینید.
  • درآمدزایی با پیکربندی «همه در یک» (AIO) دردسترس نیست.

نمای کلی نصب

مراحل زیر نحوه افزودن «خدمات درآمدزایی» به نصب موجود Apigee Edge را نشان می‌دهد:

  • از ابزار apigee-setup برای به‌روزرسانی گره «سرور مدیریت Apigee» استفاده کنید تا «خدمات درآمدزایی» را فعال کنید، برای مثال، مدیریت کاتالوگ، محدودیت‌ها و پیکربندی اعلان‌ها، صورت‌حساب، و گزارش‌دهی.

    اگر چندین گره «سرور مدیریت» دارید، مثلاً نصب ۱۳ گره‌ای، باید قبل‌از نصب «درآمدزایی»، هر دو گره «سرور مدیریت 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, SymasLDAP, 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

ادغام کردن «خدمات درآمدزایی» با همه «سرورهای مدیریت»

از روش زیر برای ادغام درآمدزایی در گره‌های «سرور مدیریت» استفاده کنید.

  1. اگر درحال نصب «درآمدزایی» روی توپولوژی Edge هستید که از چندین گره «سرور مدیریت» استفاده می‌کند، مثل نصب ۱۳ گره‌ای، مطمئن شوید که قبل‌از نصب «درآمدزایی»، هر دو گره «سرور مدیریت» را نصب کرده باشید.
  2. در گره «سرور مدیریت»، دستورگان راه‌اندازی را اجرا کنید:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    گزینه -p mo مشخص می‌کند که «درآمدزایی» ادغام شود.

    کاربر «apigee» باید به فایل پیکربندی دسترسی داشته باشد یا بتواند آن را بخواند.

  3. اگر «درآمدزایی» را روی چندین گره «سرور مدیریت» نصب می‌کنید، مرحله ۲ را روی گره دوم «سرور مدیریت» تکرار کنید.

درصورت پیکربندی موفق، طرحواره RDBMS برای «خدمات درآمدزایی» در پایگاه داده PostgreSQL ایجاد می‌شود. با این کار، ادغام «خدمات درآمدزایی» و عناصر مرتبط آن با «سرور Postgres» تکمیل می‌شود.

ادغام کردن «خدمات درآمدزایی» با همه «پردازشگرهای پیام»

از روش زیر برای ادغام درآمدزایی در همه گره‌های «پردازشگر پیام» استفاده کنید.

  1. در اولین گره «پردازشگر پیام»، در پیام‌واره فرمان، نوشتار راه‌اندازی را اجرا کنید:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    گزینه -p mo مشخص می‌کند که «درآمدزایی» ادغام شود.

    کاربر «apigee» باید به فایل پیکربندی دسترسی داشته باشد یا بتواند آن را بخواند.

  2. این رویه را در همه گره‌های «پردازشگر پیام» تکرار کنید.

در پیکربندی موفق، «پردازشگر پیام» با «خدمات درآمدزایی» به‌روز می‌شود. این کار ادغام «سرویس‌های درآمدزایی» و عناصر مرتبط آن با «پردازشگرهای پیام» را تکمیل می‌کند.

آماده‌سازی درآمدزایی

برای ایجاد یک سازمان جدید و فعال کردن درآمدزایی:

  1. سازمان را مانند هر سازمان جدید دیگری ایجاد کنید. برای اطلاعات بیشتر، به به‌کارگیری سازمان مراجعه کنید.
  2. از API آماده‌سازی درآمدزایی همان‌گونه که در فعال کردن درآمدزایی برای یک سازمان توضیح داده شده است استفاده کنید. برای انجام این کار، باید امتیازهای سرپرست سیستم داشته باشید.

وقتی دفعه بعد به «میانای کاربری Edge» وارد می‌شوید، ورودی «درآمدزایی» را در منو سطح بالای سازمان می‌بینید:

برای پیکربندی درگاه به‌منظور پشتیبانی از درآمدزایی، به پیکربندی درآمدزایی در درگاه توسعه‌دهنده مراجعه کنید.

افزودن گره «سرور مدیریت» به نصب «درآمدزایی»

اگر «سرور مدیریت» را به نصب «لبه» موجود اضافه کنید، باید مطمئن شوید که خدمات «درآمدزایی» را به «سرور مدیریت» جدید اضافه کرده‌اید و همه «سرورهای مدیریت» را پیکربندی کرده‌اید تا بتوانند با هم ارتباط برقرار کنند.

برای افزودن «سرور مدیریت»:

  1. جدید «سرور مدیریت» را نصب کنید.
  2. بااستفاده از فرمان زیر، «درآمدزایی» را در «سرور مدیریت» جدید نصب کنید:
    /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_TAX_MODEL

مقادیر پذیرفتنی «DISCLOSED»،‏ «UNDISCLOSED»،‏ «HYBRID» است (مقدار پیش‌فرض تهی است)

MINT_CURRENCY

کد ارز ISO (پیش‌فرض تهی است)

MINT_TAX_NEXUS

محل مالیات (پیش‌فرض تهی است)

MINT_DEFAULT_PROD_TAX_CATEGORY

دسته مالیاتی محصول پیش‌فرض (پیش‌فرض تهی است)

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

«سرشکن‌شده»، «ماه_تقویمی» (پیش‌فرض «ماه_تقویمی» است)

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

نشان می‌دهد که آیا سازمان برای همه توسعه‌دهندگان صورت‌حساب خودکار دارد یا نه (پیش‌فرض «false» است)

MINT_HAS_SEPARATE_INV_FOR_PROD

نشان می‌دهد که آیا سازمان برای هر محصول صورت‌حساب جداگانه دارد یا نه (پیش‌فرض «false» است)

MINT_HAS_BILLING_ADJUSTMENT

نشان می‌دهد که آیا سازمان از اصلاحات صورت‌حساب پشتیبانی می‌کند یا نه (پیش‌فرض «false» است)

features.isMonetizationEnabled

مورد استفاده میانای کاربر مدیریت برای نمایش منو ویژه درآمدزایی (پیش‌فرض «false» است)

ui.config.isOperator

مورد استفاده میانای کاربر مدیریت برای نمایش ارائه‌دهنده به‌عنوان «اپراتور» دربرابر «سازمان» (پیش‌فرض «درست» است)

برای پیکربندی تنظیمات سازمان کسب‌وکار بااستفاده از واسط کاربر مدیریت، به شروع به استفاده از درآمدزایی مراجعه کنید.

محدودیت‌های درآمدزایی

برای اعمال محدودیت‌های درآمدزایی، خط‌مشی «بررسی محدودیت‌های درآمدزایی» را به پراکسی‌های API پیوست کنید. به‌طور خاص، این خط‌مشی تحت شرایط زیر فعال می‌شود:

  • توسعه‌دهنده‌ای که به API درآمدزایی‌شده دسترسی دارد ثبت‌نام نکرده است یا در طرح نرخ اشتراک ندارد.
  • توسعه‌دهنده از حجم تراکنش برای طرح نرخ اشتراک فراتر رفته است.
  • تراز حساب پیش‌پرداخت توسعه‌دهنده یا حد اعتباری پس‌پرداخت به پایان رسیده است.

خط‌مشی «بررسی حدود درآمدزایی» در شرایطی مانند موارد فهرست‌شده در بالا، خطاها را افزایش می‌دهد و تماس‌های API را مسدود می‌کند. این خط‌مشی خط‌مشی «ایجاد خطا» را گسترش می‌دهد و می‌توانید پیام برگردانده‌شده را سفارشی‌سازی کنید. شرایط ذی‌ربط از متغیرهای کسب‌وکار استخراج می‌شود.

برای اطلاعات بیشتر، اعمال محدودیت‌های درآمدزایی بر روی پراکسی‌های API را ببینید.