התקנת שירותי מונטיזציה

שירותי המונטיזציה הם הרחבה ל-Apigee Edge, ולכן הוא לא פועל כעצמאי תהליך האימות. הוא פועל בתוך כל הגדרה קיימת של Apigee Edge, פרט ל-All-In-One (AIO) הגדרה אישית. אי אפשר להתקין שירותי מונטיזציה בהגדרה של AIO.

הדרישות למונטיזציה

  • אם מתקינים את המונטיזציה בטופולוגיה של דפדפן קצה שמשתמש בשרתי ניהול מרובים צמתים, כמו התקנה של 13 צמתים, צריך להתקין את שני הצמתים של שרת ניהול הקצה (Edge Management Server) לפני שמתקינים את המונטיזציה.
  • כדי להתקין מונטיזציה ב-Edge כאשר התקנת Edge כוללת כמה צמתים של Postgres: את צומתי ה-Postgres צריך להגדיר במצב Master/Standby. אין לך אפשרות להתקין מונטיזציה ב-Edge אם יש כמה צמתים ראשיים של Postgres. מידע נוסף זמין במאמר הגדרה של רפליקציה מסוג Master-Standby בשביל Postgres.
  • המונטיזציה לא זמינה במצב All-In-One (AIO).

סקירה כללית בנושא התקנה

השלבים הבאים ממחישים איך להוסיף שירותי מונטיזציה בממשק Apigee Edge קיים התקנה:

  • להשתמש בכלי השירות apigee-setup כדי לעדכן את הצומת של שרת הניהול של Apigee להפעיל את שירותי המונטיזציה, לדוגמה: ניהול קטלוגים, הגבלות והתראות בנושא הגדרה, חיוב ודיווח.

    אם יש לכם כמה צמתים של שרת ניהול, כמו התקנה עם 13 צמתים, צריך להתקין את שני הצמתים של שרת ניהול הקצה לפני שמתקינים את המונטיזציה.

  • שימוש בapigee-setup לעדכון מעבד ההודעות של Apigee כדי להפעיל את רכיבי זמן הריצה של שירותי מונטיזציה. לדוגמה, המדיניות בנושא הקלטת עסקאות ואכיפת הגבלות. אם יש כמה מעבדי הודעות, צריך להתקין בהם מונטיזציה.
  • מבצעים את תהליך ההצטרפות למונטיזציה עבור ארגוני Edge שלכם.
  • מגדירים את פורטל השירותים למפתחים של Apigee (או פשוט את הפורטל) כך שיתמוך במונטיזציה. מידע נוסף זמין במאמר הבא: מגדירים מונטיזציה בפורטל המפתחים.

יצירת קובץ תצורה שקט למונטיזציה

למטה מוצג קובץ תצורה שקט לדוגמה של התקנת מונטיזציה. עריכת הטקסט הזה קובץ לפי הצורך עבור ההגדרות האישיות שלכם. כדי לכלול את הקובץ הזה, משתמשים באפשרות -f כדי להגדיר את .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.
  • בהתקנה יחידה של מרכז נתונים, כל הצמתים של ZoomKeeper מוגדרים כברירת מחדל כך: מובילים. כשמתקינים את Edge במספר מרכזי נתונים, צמתים מסוימים ב-ZooKeeper מוגדרים כצופים. מוודאים שהמאפיין ZK_HOSTS שלמעלה מציין צומת מוביל ב- בהתקנה של מרכזי נתונים מרובים.
  • אם מפעילים אימות של Cassandra, אפשר להעביר את שם המשתמש והסיסמה של Cassandra באמצעות המאפיינים הבאים: 
    CASS_USERNAME
CASS_PASSWORD

שילוב שירותי המונטיזציה עם כל שרתי הניהול

יש לפעול לפי התהליך הבא כדי לשלב מונטיזציה בצמתים של שרתי ניהול.

  1. אם מתקינים את המונטיזציה בטופולוגיה של דפדפן קצה שמשתמש בשרתי ניהול מרובים צמתים, כמו התקנה של 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' (ברירת המחדל היא null)
MINT_CURRENCY

קוד מטבע ISO (ברירת המחדל היא null)
MINT_TAX_NEXUS

זיקה לצורכי מס (ברירת המחדל היא null)
MINT_DEFAULT_PROD_TAX_CATEGORY

קטגוריית המס המוגדרת כברירת מחדל למוצר (ברירת המחדל היא null)
MINT_IS_GROUP_ORG

ארגון של קבוצת IS (ברירת המחדל היא 'FALSE')
MINT_HAS_BROKER

לא תקין (ברירת המחדל היא False)
MINT_TIMEZONE

אזור זמן (ברירת המחדל היא null)
MINT_TAX_ENGINE_EXTERNAL_ID

מזהה מנגנון המס (ברירת המחדל היא null)
MINT_COUNTRY

המדינה של הארגון (ברירת המחדל היא null)
MINT_REG_NO

מספר הרישום של הארגון, בבריטניה, הערך שונה ממזהה המס (ברירת המחדל היא null)
MINT_BILLING_CYCLE_TYPE

'PRORATED', 'CALENDAR_MONTH' (ברירת המחדל היא 'CALENDAR_MONTH')
MINT_SUPPORTED_BILLING_TYPE

&quot;PREPAID&quot;/&quot;POSTPAID&quot;/&quot;BOTH&quot; (ברירת המחדל היא 'תשלום מראש')
MINT_IS_SEPARATE_INV_FOR_FEES

שדה זה מציין אם יש להפיק חשבונית עמלה נפרדת (ברירת המחדל היא 'false')
MINT_ISSUE_NETTING_STMT

שדה זה מציין אם יש להנפיק הצהרת נטוור (ברירת המחדל היא 'false')
MINT_NETTING_STMT_PER_CURRENCY

מציינת אם יש ליצור הצהרת נטו לפי מטבע (ברירת המחדל היא "false")
MINT_HAS_SELF_BILLING

מציין אם לארגון יש חיוב עצמי (ברירת המחדל היא 'false')
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

משמש בממשק המשתמש של הניהול להצגת הספק כארגון לעומת מפעיל (ברירת המחדל היא "true")

כדי לקבוע את הגדרות הארגון של העסק באמצעות ממשק המשתמש של הניהול, אפשר לעיין במאמר לתחילת השימוש במונטיזציה.

הגבלות מונטיזציה

כדי לאכוף הגבלות מונטיזציה צריך לצרף את המדיניות בנושא בדיקת הגבלות המונטיזציה לשרתי proxy ל-API. באופן ספציפי, המדיניות מופעלת בתנאים הבאים:

  • המפתח שניגש ל-API של מונטיזציה לא רשום או לא רשום למינוי לתעריף בתוכנית.
  • המפתח חרג מנפח העסקאות בתוכנית התמחור והתשלומים של המנויים.
  • הגעת ליתרת החשבון ששולם מראש או לתקרת האשראי לאחר התשלום של המפתח.

המדיניות בנושא בדיקת הגבלות המונטיזציה מעלה כשלים וחוסמת קריאות ל-API במצבים כמו שרשומים למעלה. המדיניות הזו תרחיב את המדיניות 'דיווח על כשלים', ותוכלו להתאים אישית את ההודעה הוחזרו. התנאים הרלוונטיים נגזרים ממשתנים עסקיים.

למידע נוסף, ראו אכיפה הגבלות מונטיזציה על שרתי proxy ל-API.