نصب خدمات کسب درآمد

خدمات کسب درآمد یک برنامه افزودنی برای Apigee Edge است، از این رو به عنوان یک فرآیند مستقل اجرا نمی شود. در هر تنظیمات موجود Apigee Edge اجرا می شود، به استثنای پیکربندی All-In-One (AIO). شما نمی توانید خدمات کسب درآمد را روی پیکربندی AIO نصب کنید.

الزامات کسب درآمد

  • اگر کسب درآمد را روی توپولوژی Edge نصب می‌کنید که از چندین گره مدیریت سرور استفاده می‌کند، مانند نصب 13 گره، باید قبل از نصب کسب درآمد، هر دو گره سرور مدیریت Edge را نصب کنید.
  • برای نصب کسب درآمد در Edge که نصب Edge دارای چندین گره Postgres است، گره های Postgres باید در حالت Master/Standby پیکربندی شوند. اگر چندین گره اصلی Postgres دارید، نمی‌توانید کسب درآمد را روی Edge نصب کنید. برای اطلاعات بیشتر، به تنظیم Master-Standby Replication برای Postgres مراجعه کنید.
  • کسب درآمد با پیکربندی All-In-One (AIO) در دسترس نیست.

نمای کلی نصب

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

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

    اگر چندین گره مدیریت سرور دارید، مانند نصب 13 گره، باید هر دو گره سرور مدیریت Edge را قبل از نصب کسب درآمد نصب کنید.

  • از ابزار apigee-setup برای به روز رسانی پردازشگر پیام Apigee استفاده کنید تا اجزای زمان اجرا خدمات کسب درآمد را فعال کنید، به عنوان مثال، خط مشی ضبط تراکنش و اعمال محدودیت. اگر چندین پردازشگر پیام دارید، Monetization را روی همه آنها نصب کنید.
  • فرآیند ورود کسب درآمد را برای سازمان های 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. در اولین گره پردازشگر پیام، در خط فرمان، اسکریپت تنظیم را اجرا کنید:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    گزینه -p mo یکپارچه سازی درآمدزایی را مشخص می کند.

    فایل پیکربندی باید توسط کاربر "apigee" قابل دسترسی یا خواندن باشد.

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

در پیکربندی موفقیت آمیز، پردازشگر پیام با خدمات کسب درآمد به روز می شود. این یکپارچه سازی خدمات کسب درآمد و اجزای مرتبط با آن با پردازشگرهای پیام را تکمیل می کند.

ورود به کسب درآمد

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

  1. سازمان را مانند هر سازمان جدید ایجاد کنید. برای کسب اطلاعات بیشتر، در سازمان حضور داشته باشید.
  2. از API تأمین درآمد همانطور که در «فعال کردن کسب درآمد برای سازمان» توضیح داده شده است استفاده کنید. برای انجام این کار، باید از حقوق مدیر سیستم برخوردار باشید.

وقتی بعداً وارد رابط کاربری 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

مقادیر پذیرفته شده عبارتند از "DisCLOSED"، "UNDISCLOSED"، "HYBRID" (پیش فرض صفر است)

MINT_CURRENCY

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

MINT_TAX_NEXUS

رابطه مالیاتی (پیش فرض صفر است)

MINT_DEFAULT_PROD_TAX_CATEGORY

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

MINT_IS_GROUP_ORG

سازمان گروه IS (پیش‌فرض "نادرست" است)

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

"پیش پرداخت"/"پس از پرداخت"/"هم" (پیش فرض "پیش پرداخت" است)

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

استفاده شده توسط رابط کاربری مدیریت برای نمایش ارائه دهنده به عنوان Operator verses Organization (پیش‌فرض "درست" است)

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

محدودیت های کسب درآمد

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

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

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

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