Edge for Private Cloud גרסה 4.17.05
שירותי המונטיזציה הם הרחבה ל-Apigee Edge, ולכן הוא לא פועל כעצמאי תהליך האימות. הוא פועל בכל הגדרה קיימת של Apigee Edge.
הדרישות למונטיזציה
- אם מתקינים את המונטיזציה בטופולוגיה של דפדפן קצה שמשתמש בשרתי ניהול מרובים צמתים, כמו התקנה של 13 צמתים, צריך להתקין את שני הצמתים של שרת ניהול הקצה (Edge Management Server) לפני שמתקינים את המונטיזציה.
- כדי להתקין מונטיזציה ב-Edge כאשר התקנת Edge כוללת כמה צמתים של Postgres: את צומתי ה-Postgres צריך להגדיר במצב Master/Standby. אין לך אפשרות להתקין מונטיזציה ב-Edge אם יש כמה צמתים ראשיים של Postgres. למידע נוסף, ראו הגדרת רפליקציית Master-Standby עבור Postgres.
סקירה כללית בנושא התקנה
השלבים הבאים ממחישים איך להוסיף שירותי מונטיזציה בממשק Apigee Edge קיים התקנה:
- משתמשים ב-apigee-setup
לעדכון הצומת של שרת הניהול של Apigee כדי להפעיל את שירותי המונטיזציה,
לדוגמה, ניהול קטלוג, מגבלות והגדרת התראות, חיוב
דיווח.
אם יש לכם כמה צמתים של שרת ניהול, כמו התקנה עם 13 צמתים, צריך צריך להתקין את שני הצמתים של שרת ניהול הקצה לפני שמתקינים את המונטיזציה. - משתמשים ב-apigee-setup לעדכון מעבד ההודעות של Apigee כדי להפעיל את רכיבי זמן הריצה של שירותי מונטיזציה. לדוגמה, המדיניות בנושא הקלטת עסקאות ואכיפת הגבלות. אם יש כמה מעבדי הודעות, צריך להתקין בהם מונטיזציה.
- מבצעים את תהליך ההצטרפות למונטיזציה עבור ארגוני Edge שלכם.
- הגדרת פורטל השירותים למפתחים כך שיתמוך במונטיזציה. מידע נוסף זמין במאמר הבא: http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.
יצירת קובץ תצורה שקט עבור מונטיזציה
למטה מוצג קובץ תצורה שקט לדוגמה של התקנת מונטיזציה. עריכת הטקסט הזה קובץ לפי הצורך עבור ההגדרות האישיות שלכם. כדי לכלול את הקובץ הזה, משתמשים באפשרות -f כדי להגדיר את .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.
- בהתקנה יחידה של מרכז נתונים, כל הצמתים של ZoomKeeper מוגדרים כברירת מחדל כך: מובילים. כשמתקינים את Edge במספר מרכזי נתונים, צמתים מסוימים ב-ZooKeeper מוגדרים כצופים. מוודאים שהמאפיין ZK_HOSTS שלמעלה מציין צומת מוביל ב- בהתקנה של מרכזי נתונים מרובים.
- אם מפעילים אימות של Cassandra, אפשר להעביר את שם המשתמש והסיסמה של Cassandra
באמצעות המאפיינים הבאים:
CASS_USERNAME
CASS_PASSWORD
שילוב שירותי מונטיזציה עם כל שרתי הניהול
יש לפעול לפי התהליך הבא כדי לשלב מונטיזציה בצמתים של שרתי ניהול.
- אם מתקינים את המונטיזציה בטופולוגיה של דפדפן קצה שמשתמש בשרתי ניהול מרובים צמתים, כמו התקנה של 13 צמתים, ואז לוודא שהתקנתם את שני שרתי הניהול לפני שמתקינים את המונטיזציה.
- בצומת של שרת הניהול, מריצים את סקריפט ההגדרה:
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
האפשרות ' -p mo' מציינת שילוב של מונטיזציה.
קובץ התצורה חייב להיות נגיש או קריא באמצעות ה-apigee משתמש. - אם מתקינים את המונטיזציה בכמה צמתים של שרתי ניהול, צריך לחזור על שלב 2 גם הצומת השני של שרת הניהול.
אחרי שההגדרה תבוצע בהצלחה, תיווצר סכימת RDBMS לשירותי מונטיזציה במסגרת מסד נתונים של PostgreSQL. השלמת השילוב של שירותי המונטיזציה והשיוך שלהם רכיבים עם שרת Postgres.
שילוב שירותי מונטיזציה עם כל מעבדי ההודעות
עליכם לבצע את התהליך הבא כדי לשלב מונטיזציה בכל מעבדי ההודעות. צמתים.
- בצומת הראשון של מעבד ההודעות, בשורת הפקודה, מריצים את סקריפט ההגדרה:
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
האפשרות ' -p mo' מציינת שילוב של מונטיזציה.
קובץ התצורה חייב להיות נגיש או קריא באמצעות ה-apigee משתמש. - חוזרים על התהליך הזה בכל הצמתים של מעבד ההודעות.
לאחר השלמת ההגדרה, מעבד ההודעות מעודכן עם שירותי המונטיזציה. הזה ישלים את השילוב של שירותי המונטיזציה והרכיבים המשויכים אליהם עם ההודעה מעבדים.
הדרכה למשתמשים חדשים בנושא מונטיזציה
כדי ליצור ארגון חדש שמופעלת בו מונטיזציה, עליך ליצור תחילה את הארגון בתור שכל ארגון חדש יוצר. מידע נוסף זמין במאמר הצטרפות לארגון.
תהליך קליטה נוסף כדי להפעיל מונטיזציה בארגון
כדי להשלים את תהליך ההצטרפות למונטיזציה בארגון, תצטרכו:
- יוצרים את קבוצת המונטיזציה: 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 allow-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 |
הערכים הקבילים 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 (ברירת המחדל היא DATE_MONTH) |
|
MINT_SUPPORTED_BILLING_TYPE |
תשלום מראש/תשלום לאחר השימוש (postpay)/שניהם (ברירת המחדל היא תשלום מראש) |
|
MINT_IS_SEPARATE_INV_FOR_FEES |
השדה הזה מציין אם צריך להפיק חשבונית עמלה נפרדת (ברירת המחדל היא False) |
|
MINT_ISSUE_NETTING_STMT |
שדה זה מציין אם צריך להנפיק הצהרת נטוור (ברירת המחדל היא False) |
|
MINT_NETTING_STMT_PER_CURRENCY |
מציינת אם יש ליצור הצהרת נטו לפי מטבע (ברירת המחדל היא לא נכון) |
|
MINT_HAS_SELF_BILLING |
שדה זה מציין אם לארגון יש חיוב עצמי (ברירת המחדל היא False) |
|
MINT_SELF_BILLING_FOR_ALL_DEV |
מציינת אם לארגון יש חיוב עצמי לכל המפתחים(ברירת המחדל היא לא נכון) |
|
MINT_HAS_SEPARATE_INV_FOR_PROD |
מציינת אם לארגון יש חשבונית נפרדת לכל מוצר (ברירת המחדל היא לא נכון) |
|
MINT_HAS_BILLING_ADJUSTMENT |
שדה זה מציין אם הארגון תומך בהתאמות חיוב (ברירת המחדל היא False) |
|
features.isMonetizationEnabled |
משמש את ממשק המשתמש של הניהול להצגת תפריט ספציפי למונטיזציה (ברירת המחדל היא False) |
|
ui.config.isOperator |
משמש בממשק המשתמש של הניהול להצגת הספק כארגון לעומת מפעיל (ברירת המחדל היא True) |
כדי לקבוע את הגדרות הארגון העסקי באמצעות ממשק המשתמש של הניהול, יש לעיין בכתובת http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.
הערה: אם אתם משתמשים בהגבלות ובהתראות של שירותי מונטיזציה עליך להנחות את המפתחים שלך לצרף מדיניות מגבלה בתהליך ה-proxy לאחר מדיניות האימות של אסימון גישה.
מדיניות מגבלות היא מדיניות מפורשת שנועדה לחסום קריאה ל-API אם חלה מגבלה מסוימת הגעת. המדיניות בודקת את המגבלות העסקיות ומפירה את כללי המדיניות אם יש חריגה מהמגבלות בערך שהוגדר. זוהי הרחבה של המדיניות בנושא כשלים, אבל התנאים נגזרים ממשתנים עסקיים.
בממשק המשתמש לניהול יש תבנית של ממשק משתמש עבור מפתחים של שרתי proxy. על מפתח/ת proxy לצרף מדיניות מטבעה בתהליך ההודעה. עם ביצוע המדיניות הזו, הטעות תורמת עם הודעת השגיאה, בהתאם למדיניות. אם הערך של ContinueOnError מוגדר כ-True, הטעות נחשבת לא יגדל ומשתני הזרימה "mint.limitsViolated", "mint.isDeveloper suspendeded" ו-"mint.limitsPolicyError" יוגדרו משתנים שיכול לשמש לטיפול נוסף בחריגות במקרה הצורך.