מוצג המסמך של Apigee Edge.
עוברים אל
מסמכי תיעוד של Apigee X. מידע
הקטעים הבאים מציגים את פרופיל הארגון ומתארים איך ניתן לנהל אותו באמצעות ממשק המשתמש ו-API.
מידע על פרופיל הארגון
במסגרת ההגדרה הראשונית של המונטיזציה, צוות ההגדרה של Apigee Edge מגדיר את הפרופיל הארגון שלך.
עליך לערוך את פרופיל הארגון כדי להוסיף או לעדכן מידע על הארגון, לפי הצורך. לדוגמה, ייתכן שתצטרכו לעדכן את סוג החיוב, את הגדרות המטבע או את מודל המס.
הגדרת מידע בסיסי על הארגון שלך, כולל:
- השם, הכתובת ומדינת הפעילות של הארגון
- סוג החיוב (תשלום מראש, תשלום לאחר השימוש (postpay או שניהם), כפי שמתואר במאמר הסבר על סוג החיוב
- מחזור חיובים (מחלק או לפי חודש קלנדרי)
- מטבע הבסיס
- מודל המס שמשמש את הארגון שלך
אתם יכולים לנהל את פרופיל הארגון באמצעות ממשק המשתמש וה-API, כפי שמתואר ב- בקטעים הבאים.
הדף 'פרופיל הארגון'
נכנסים לדף 'פרופיל הארגון', כמו שמתואר בהמשך.
Edge
כדי לגשת לדף Organization Profile (פרופיל הארגון) באמצעות ממשק המשתמש של Edge:
- נכנסים לחשבון בכתובת apigee.com/edge.
- בוחרים באפשרות פרסום > מונטיזציה > פרופיל הארגון בסרגל הניווט הימני.
הדף 'פרופיל הארגון' מוצג.
כפי שמודגש באיור, הדף 'פרופיל הארגון' מאפשר לכם:
- הצגת ההגדרות הנוכחיות של הפרופיל בארגון
- לערוך את הגדרות הפרופיל של הארגון, כולל:
- שם ופרטים
- מיסים ומטבע
- לתנאים ולהגבלות, כפי שמתואר בניהול התנאים וההגבלות
Classic Edge (ענן פרטי)
כדי לגשת לדף פרופיל הארגון באמצעות ממשק המשתמש של הגרסה הקלאסית של Edge:
- יש להיכנס אל
http://ms-ip:9000
, כאשר ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול. - בוחרים באפשרות ניהול > פרופיל הארגון בסרגל הניווט העליון.
הדף 'פרופיל הארגון' מוצג.
הדף 'פרופיל הארגון' מאפשר לכם:
- הצגת ההגדרות הנוכחיות של הפרופיל בארגון
- לערוך את הגדרות הפרופיל של הארגון, כולל:
- שם ופרטים
- מיסים ומטבע
- לתנאים ולהגבלות, כפי שמתואר בניהול התנאים וההגבלות
עריכה של פרופיל הארגון באמצעות ממשק המשתמש
כך עורכים את פרופיל הארגון באמצעות ממשק המשתמש:
- נכנסים לדף פרופיל הארגון.
- לוחצים על עריכה.
- בקטע שם ומידע, עורכים את שם הארגון ואת מדינת הפעילות.
- בקטע מיסים ומטבע, עורכים את השדות הבאים:
שדה תיאור מודל מס הערה: רלוונטי רק אם הגדרתם תוכניות של תעריפים לחלוקת הכנסות ואתם רוצים כדי ליצור מסמכי חיוב.
מודל מס לתוכניות לחלוקת הכנסות שמזהה את סוג מסמכי החיוב הנדרשים.
הערכים החוקיים כוללים:
- גילוי נאות: ספק ה-API פועל כסוכן מורשה של למפתחים. ההכנסה ברוטו (כולל מיסי מכירה) שנגבית ממשתמש הקצה היא הועברו למפתח. העמלה של ספק ה-API גובה של המפתח בצורה של חשבונית עמלה. ספק ה-API לא מטפל מס המכירות שנגבה ממשתמש הקצה, ובאחריות המפתח כדי לדווח על מס המכירה.
- לא צוין: ספק ה-API פועל כסוכן לא מדווח של למפתח שלה, ומנכה את המס שנגבה ממשתמשי הקצה ומשלם אותו לרשויות המס המקומיות. המפתח מנפיק חשבונית לספק ה-API על ההכנסה נטו חלק מהמפתח (פחות מיסי מכירה וניכוי מס במקור על ידי ספק ה-API) עמלה).
- היברידי: ספק ה-API משמש כסוכן בעל גילוי נאות למפתחים. עם זאת, ספק ה-API משלם את מס המכירה שנגבה מנויים לרשויות המס המקומיות בשם המפתח. ממשק API הספק מעביר את שאר ההכנסות למפתח, ולאחר מכן חשבוניות על עמלות.
מטבע המטבעות שבהם הארגון שלך תומך. לגבי תוכניות של חלוקת הכנסות, מחירון ותוכניות עמלות בלבד, מטבע ברירת המחדל משמש בתוכנית התעריפים שלכם. כשיוצרים תוכנית תמחור ותשלומים או תוכנית עמלות בלבד, אפשר לשנות את המטבע להגדרת המטבע להשתמש בו על ידי בחירה מתוך רשימה של מטבעות נתמכים. לחלופין, אתם יכולים להגדיר את הסכום המינימלי להוספת כסף שמפתחי האפליקציות יכולים להוסיף ליתרה ששולמה מראש בחשבון שלהם עבור כל מטבע.
כדי להוסיף מטבע:
- לוחצים על הוספת מטבע.
- בוחרים מטבע מהתפריט הנפתח בשדה מטבע.
- אם רוצים, אפשר להגדיר את הסכום המינימלי שמפתחי אפליקציות יכולים להוסיף ליתרה בחשבון בתשלום מראש במטבע שצוין בשדה סכום כסף מינימלי.
- לוחצים על הוספה.
- אם רוצים להגדיר את מטבע ברירת המחדל, לוחצים על לחצן הבחירה המשויך.
- חוזרים על השלבים להוספת מטבעות.
כדי למחוק מטבע, מציבים את הסמן מעל המטבע שרוצים למחוק ולוחצים על
.
- לנהל את התנאים וההגבלות, כפי שמתואר בניהול התנאים וההגבלות באמצעות ממשק המשתמש.
- לוחצים על שמירה.
ניהול פרופיל הארגון באמצעות ה-API
לנהל את פרופיל הארגון באמצעות ה-API, כפי שמתואר בסעיפים הבאים.
צפייה בפרופיל הארגון באמצעות ה-API
כדי לצפות בפרופיל הארגון שלך, יש לשלוח בקשת GET אל
/mint/organizations/{org_name}
לדוגמה:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Accept: application/json" \ -u email:password
הדוגמה הבאה ממחישה את התשובה. מידע נוסף על האפשרויות מידע נוסף מופיע בקטע מאפיינים של הגדרת פרופיל הארגון ל-API.
{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "{org_name}" "issueNettingStmt" : false, "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "myorg", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : true, "status" : "ACTIVE", "supportedBillingType" : "PREPAID", "taxModel" : "UNDISCLOSED", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }
עריכה של פרופיל הארגון באמצעות ה-API
כדי לערוך את פרופיל הארגון, יש לשלוח בקשת PUT אל
/mint/organizations/{org_name}
כשעורכים את פרופיל הארגון, צריך לציין את כל הערכים
מאפיינים של פרופיל ארגון, לא רק המאפיינים שאתם עורכים.
כדי לערוך את מטבע ברירת המחדל של הארגון, צריך להגדיר את הערך של currency
בתור
מטבע בתקן ISO 4217
של המטבע הנתמך שאותו רוצים להגדיר כברירת מחדל.
לדוגמה, הקריאה הבאה ל-API מעדכנת את currency
ל-USD ולמודל המס
HYBRID
(השדות המעודכנים מודגשים בדוגמה). לקבלת מידע נוסף
מידע על האפשרויות שמוצגות מופיע במאמר הגדרת פרופיל הארגון
מאפייני ה-API.
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
הגדרת סוגי חיובים בתשלום מראש ובתשלום לאחר השימוש באמצעות ה-API
אפשר להגדיר חשבונות פיתוח לשימוש בסוגי החיוב הבאים: תשלום מראש, תשלום לאחר השימוש או שניהם.
בחשבונות בתשלום מראש, המפתחים משלמים מראש על השימוש בממשקי ה-API שלכם. הכספים מנוכים מהיתרה המשולמת מראש של המפתח, שמתוחזקת באמצעות ספק תשלומים משולב. המפתח חייב לשמור על יתרה מהפקדה מראש שמספיקה לרכישת ממשקי ה-API.
בחשבונות בתשלום לאחר השימוש (postpay), המפתחים מחויבים מדי חודש (באמצעות חשבונית) בסוף החודש. המפתח משלם על השימוש במוצרי API על סמך תנאי התשלום שהוגדרו על ידי התוכניות שכלולות בחשבונית.
כדי להגדיר בארגון סוגי חיוב בתשלום מראש ובתשלום לאחר השימוש, צריך להגדיר את הנכס supportedBillingType
לאחד
כדי לציין אילו סוגי חיוב חוקיים: PREPAID
, POSTPAID
או BOTH
. אם מגדירים את הערך ל-BOTH
,
ברירת המחדל תהיה PREPAID
כשמוסיפים מפתח אפליקציות או חברה. במקרה כזה, ניתן להגדיר במפורש את סוג החיוב עבור חברה או מפתח אפליקציות באמצעות ה-API, כפי שמתואר ב
ניהול חברות ומפתחי אפליקציות.
לדוגמה:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
הגדרת מחזור החיובים באמצעות ה-API
כדי להגדיר את מחזור החיובים לארגון, צריך להגדיר את המאפיין billingCycle
לאחד מהערכים הבאים:
PRORATED
: החיוב מבוסס על מספר הימים שבהם נעשה שימוש במוצר API בחודש קלנדרי.CALENDAR_MONTH
: החיוב מתבצע מדי חודש.
לדוגמה:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
מאפייני תצורה של פרופיל ארגון ל-API
פרופיל הארגון מאפשר לך להגדיר את מאפייני ההגדרות הבאים באמצעות ה-API.
שם | תיאור | ברירת מחדל | חובה? |
---|---|---|---|
address |
כתובת הארגון, שיכולה לכלול את הרחוב, העיר, המדינה, המיקוד קוד המדינה, וכן אינדיקציה אם זו הכתובת הראשית עבור של הארגון. |
לא רלוונטי | לא |
approveTrusted |
הדגל הזה לא בשימוש. |
לא רלוונטי | לא |
approveUntrusted |
הדגל הזה לא בשימוש. |
לא רלוונטי | לא |
billingCycle |
התקופה של מחזור החיובים. הערך יכול להיות אחד מהערכים הבאים:
מידע נוסף זמין בקטע הגדרת מחזור החיובים באמצעות ה-API. |
לא רלוונטי | כן |
country |
קוד ISO 3166-2 של המדינה הפעילות של הארגון, כמו ברזיל בברזיל. |
לא רלוונטי | כן |
currency |
קוד ISO 4217 של הפרמטר base או המטבע החשבונאי שבו משתמש הארגון (למשל USD עבור ארצות הברית דולר ארה"ב). בתוכניות לחלוקת הכנסות: המטבע שצוין משמש בתוכנית שלכם. בתוכניות מחירון (מודל חיוב): הדבר נכון גם לגבי תוכניות לחלוקת הכנסות. עם זאת, תוכל לשנות את הגדרת המטבע לכל מטבע שנתמך על ידי של הארגון. בתוכניות עם עמלות בלבד: אפשר לשנות את הגדרת המטבע לכל מטבע שנתמך על ידי בארגון. |
לא רלוונטי | כן |
description |
תיאור קצר של הארגון. |
לא רלוונטי | לא |
hasBillingAdjustment |
סימון שמציין אם ההתאמות מופעלות. אם ההגדרה מופעלת, אפשר התאמות בפרטי התנועה שתועדו על ידי שירותי API עבור מוצרי ה-API שלך יכול להיות אחת מהאפשרויות הבאות:
|
לא רלוונטי | לא |
hasBroker |
סימון שמציין אם ההכנסה מבוססת על נטו. הערך יכול להיות אחד או יותר הבאים:
|
לא רלוונטי | לא |
hasSelfBilling |
סימון שמפנה את המונטיזציה ליצירת חשבונית לחיוב עצמי במקום להכנסה הצהרת שיתוף. חשבונית לחיוב עצמי היא מסמך פיננסי שבו מפורט הסכום בגלל מפַתח האפליקציה. היא משמשת כחשבונית לספק ה-API מטעם מפתח אפליקציות. הערך יכול להיות כל אחד מהערכים הבאים:
|
לא רלוונטי | לא |
hasSeparateInvoiceForProduct |
סימון שמציין אם תופק חשבונית נפרדת לכל מוצר API. יכול להיות אחת מהאפשרויות הבאות:
|
לא רלוונטי | לא |
id |
המזהה של הארגון. |
לא רלוונטי | לא |
issueNettingStmt |
סימון שמציין אם נוצרת הצהרת רווח בזמן יצירת החיוב מסמכים. הערך יכול להיות כל אחד מהערכים הבאים:
|
לא רלוונטי | לא |
logoUrl |
כתובת ה-URL של הלוגו של הארגון. |
לא רלוונטי | לא |
name |
שם הארגון. |
לא רלוונטי | כן |
netPaymentAdviceNote |
הערה על ייעוץ תשלום נטו. |
לא רלוונטי | לא |
nettingStmtPerCurrency |
סימון שמציין אם הצהרת רשת נפרדת נוצרת לכל המטבע שבו נעשה שימוש. הערך יכול להיות כל אחד מהערכים הבאים:
|
לא רלוונטי | לא |
regNo |
מספר הרישום של הארגון. המספר שיוזן לנכס הזה הוא בתחתית של מסמכי החיוב. |
לא רלוונטי | לא |
selfBillingAsExchOrg |
אם חשבוניות לחיוב עצמי מופעלות, מציין אם הן מופעלות לצורכי החלפה ארגונים. הערך יכול להיות כל אחד מהערכים הבאים:
|
לא רלוונטי | לא |
selfBillingForAllDev |
אם האפשרות 'חשבוניות לחיוב עצמי מופעלת', מציינת אם היא מופעלת לכולם למפתחי אפליקציות. כברירת מחדל, חשבוניות בחיוב עצמי מופקות רק למפתחי אפליקציות חתמת על הסכם עם ספק ה-API. הערך יכול להיות כל אחד מהערכים הבאים:
|
false | לא |
separateInvoiceForFees |
סימון שמציין אם מתפרסמת חשבונית נפרדת בגין עמלות. הערך יכול להיות אחד מהתנאים הבאים:
|
false | כן |
status |
הסטטוס של הארגון. הערכים החוקיים כוללים:
|
לא רלוונטי | לא |
supportedBillingType |
מודל התשלום למפתחים שמשמש לחיוב. הערך יכול להיות אחד מהערכים הבאים:
מידע נוסף זמין במאמר הגדרת סוגי חיוב בתשלום מראש ובתשלום לאחר השימוש (postpay) באמצעות ה-API. |
תשלום מראש | כן |
taxModel |
הערה: רלוונטי רק אם הגדרתם תוכניות של תעריפים לחלוקת הכנסות ואתם רוצים כדי ליצור מסמכי חיוב. מודל מס לתוכניות לחלוקת הכנסות שמזהה את סוג מסמכי החיוב הנדרשים. הערכים החוקיים כוללים:
|
לא רלוונטי | כן |
taxNexus |
המדינה שבה הארגון רשום למטרות מס. |
לא רלוונטי | לא |
taxRegNo |
מספר רישום המס של הארגון או רישום למס ערך מוסף (מע"מ) מספר, אם רלוונטי. הנכס הזה אופציונלי כי מספר רישום המס או מספר רישום המע"מ לא חל בכל המדינות. המספר שיוזן בשדה הזה מוצג בחלק התחתון של מסמכי החיוב. |
לא רלוונטי | לא |
transactionRelayURL |
כתובת URL של מערכת אחרת שאליה ניתן להעביר עסקאות, כמו נתונים מחסן. |
לא רלוונטי | לא |
timezone |
מזהה אזור הזמן של פעילויות הארגון, כגון America/New_York או אירופה/פריז. קיצורים של אזורי זמן, כמו UTC, EST (מזרח אפשר להגדיר גם שעון רגיל (שעון מרכז אירופה) או CET (שעון מרכז אירופה). |
לא רלוונטי | כן |
ביטול ההגדרות של פרופיל המונטיזציה לחברה או למפתח אפליקציות
לשנות את הגדרות פרופיל המונטיזציה לחברה או למפתח אפליקציות באמצעות ממשק המשתמש או ה-API, כפי שמתואר בסעיפים הבאים: