ניהול הפרופיל של הארגון

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

בקטעים הבאים נסביר על פרופיל הארגון ונראה איך לנהל אותו באמצעות ממשק המשתמש ו-API.

מידע על פרופיל הארגון

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

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

מגדירים מידע בסיסי על הארגון, כולל:

• השם, הכתובת והמדינה שבה פועל הארגון
• סוג החיוב (בתשלום מראש, בתשלום לאחר השימוש או בשניהם), כפי שמתואר בקטע הסבר על סוג החיוב
• מחזור החיובים (פרו-ראטה או חודש קלנדרי)
• מטבע בסיס
• מודל המס שבו הארגון משתמש

אתם יכולים לנהל את פרופיל הארגון באמצעות ממשק המשתמש ו-API, כפי שמתואר בקטעים הבאים.

הדף 'פרופיל הארגון'

נכנסים לדף 'פרופיל הארגון', כפי שמתואר בהמשך.

עריכת פרופיל הארגון באמצעות ממשק המשתמש

כדי לערוך את פרופיל הארגון באמצעות ממשק המשתמש:

1. נכנסים לדף Organization Profile (פרופיל הארגון).
2. לוחצים על עריכה.
3. בקטע שם ומידע, עורכים את שם הארגון ואת מדינה הפעולה.
4. בקטע מיסים ומטבע, עורכים את השדות הבאים:

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

5. לנהל את התנאים וההגבלות, כפי שמתואר במאמר ניהול התנאים וההגבלות באמצעות ממשק המשתמש.
6. לוחצים על שמירה.

ניהול פרופיל הארגון באמצעות ה-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.

בחשבונות לחיוב לאחר התשלום, המפתחים מחויבים מדי חודש (באמצעות חשבונית) בסוף החודש. המפתח משלם על השימוש במוצרי ה-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 בחודש קלנדרי. CALENDAR_MONTH: החיוב מתבצע מדי חודש. הגדרת מחזור החיובים באמצעות ה-API	לא רלוונטי	כן
country	קוד ISO 3166-2 של המדינה שבה פועל הארגון, למשל BR לברזיל.	לא רלוונטי	כן
currency	קוד ISO 4217 של המטבע 'הבסיסי' או המטבע לצורכי חשבונאות שבו הארגון משתמש (למשל USD לדולר ארה"ב). בתוכניות חלוקת הכנסות: התוכנית תשתמש במטבע שציינתם. בתוכניות עם מחירון (מודל חיוב): התנאים זהים לתוכניות עם חלוקת הכנסות. עם זאת, אפשר לשנות את הגדרת המטבע לכל מטבע שנתמך על ידי הארגון. בתוכניות של עמלות בלבד: אפשר לשנות את הגדרת המטבע לכל מטבע שנתמך על ידי הארגון.	לא רלוונטי	כן
description	תיאור קצר של הארגון.	לא רלוונטי	לא
hasBillingAdjustment	סימון שמציין אם ההתאמות מופעלות. אם ההגדרה הזו מופעלת, תוכלו לבצע התאמות לפרטי התנועה שמתועדים על ידי שירותי ה-API למוצרי ה-API שלכם. הערך יכול להיות אחד מהערכים הבאים: true: ההתאמות מופעלות. false: ההתאמות לא מופעלות.	לא רלוונטי	לא
hasBroker	דגל שמציין אם ההכנסה מבוססת על נטו. הערך יכול להיות אחד מאלה: true: ההכנסה מבוססת על נתונים נטו. false: ההכנסה לא מבוססת על נתונים נטו.	לא רלוונטי	לא
hasSelfBilling	דגל שמורה למערכת המונטיזציה ליצור חשבונית לחיוב עצמי במקום דף חשבון של חלוקת הכנסות. חשבונית לחיוב עצמי היא מסמך פיננסי שמפרט את הסכום שצריך לשלם למפתח האפליקציה. הוא משמש חשבון לספק ה-API מטעם מפתח האפליקציה. הערך יכול להיות אחד מהערכים הבאים: true: יצירת חשבוניות לחיוב עצמי במקום דפי חשבון של חלוקת הכנסות. false: משבית את החשבוניות לחיוב עצמי.	לא רלוונטי	לא
hasSeparateInvoiceForProduct	דגל שמציין אם נוצרת חשבונית נפרדת לכל מוצר API. הערך יכול להיות אחד מהערכים הבאים: true: המערכת יוצרת חשבונית נפרדת לכל מוצר API. false: לא נוצרת חשבונית נפרדת לכל מוצר API.	לא רלוונטי	לא
id	המזהה של הארגון.	לא רלוונטי	לא
issueNettingStmt	דגל שמציין אם נוצר דף חשבון נטו כשיוצרים מסמכי חיוב. הערך יכול להיות אחד מהערכים הבאים: true: דף יתרה נוצר כשיוצרים מסמכי חיוב. false: דף יתרה לא נוצר כשיוצרים מסמכי חיוב.	לא רלוונטי	לא
logoUrl	כתובת ה-URL של הלוגו של הארגון.	לא רלוונטי	לא
name	שם הארגון.	לא רלוונטי	כן
netPaymentAdviceNote	הערה לגבי ייעוץ לתשלום נטו.	לא רלוונטי	לא
nettingStmtPerCurrency	דגל שמציין אם נוצר דף חשבון נטו נפרד לכל מטבע שבו נעשה שימוש. הערך יכול להיות אחד מהערכים הבאים: true: נוצר דף חשבון נפרד לכל מטבע שבו נעשה שימוש. false: לא נוצר דף חשבון נפרד של סינון לכל מטבע שבו נעשה שימוש.	לא רלוונטי	לא
regNo	מספר הרישום של הארגון. המספר שתזינו לנכס הזה יופיע בחלק התחתון של מסמכי החיוב.	לא רלוונטי	לא
selfBillingAsExchOrg	אם החיוב בחשבוניות בניהול עצמי מופעל, השדה הזה מציין אם הוא מופעל לארגונים של זירת מסחר. הערך יכול להיות אחד מהערכים הבאים: true: חשבוניות לחיוב עצמי מופעלות לארגוני המרות. false: חשבוניות לחיוב עצמי לא מופעלות בארגונים של פלטפורמות להמרת מטבעות.	לא רלוונטי	לא
selfBillingForAllDev	אם החשבוניות לחיוב עצמי מופעלות, האפשרות הזו מציינת אם הן מופעלות לכל מפתחי האפליקציות. כברירת מחדל, חשבוניות לחיוב עצמי נוצרות רק למפתחי אפליקציות שחתמו על הסכם עם ספק ה-API. הערך יכול להיות אחד מהערכים הבאים: true: החשבוניות לחיוב עצמי מופעלות לכל מפתחי האפליקציות. שגוי: חשבוניות לחיוב עצמי לא מופעלות לכל מפתחי האפליקציות.	FALSE	לא
separateInvoiceForFees	דגל שמציין אם חשבונית נפרדת תפורסם עבור עמלות. הערך יכול להיות אחד מהערכים הבאים: true: חשבונית נפרדת מתפרסמת עבור עמלות. false: Separate invoice is not published for fees.	FALSE	כן
status	הסטטוס של הארגון. הערכים החוקיים כוללים: פעיל: החשבון הארגוני רשום למונטיזציה וזמין לשימוש. לא פעיל: חשבון הארגון רשום למונטיזציה, אבל לא זמין לשימוש.	לא רלוונטי	לא
supportedBillingType	מודל התשלום של המפתח שמשמש לחיוב. הערך יכול להיות אחד מהערכים הבאים: PREPAID: המפתח משלם מראש על השימוש במוצר API. הכספים ינוכו מהיתרה של המפתח כשמשתמשים במוצר ה-API. המפתח צריך לשמור על יתרה מספקת בתשלום מראש כדי לרכוש את מוצר ה-API. חיוב בחיוב חודשי: המפתח מחויב מדי חודש (באמצעות חשבונית) על השימוש במוצרי ה-API. המפתח משלם על השימוש במוצרי ה-API בהתאם לתנאי התשלום שמוגדרים בחבילות שכלולות בחשבונית. שניהם: תמיכה בשני סוגי החיוב. ברירת המחדל היא PREPAID. אפשר לעיין במאמר הגדרת סוגי חיוב מראש וחיובים לאחר התשלום באמצעות ה-API.	PREPAID	כן
taxModel	הערה: ההגדרה הזו רלוונטית רק אם הגדרתם תוכניות של שיעורי חלוקת הכנסות ואתם רוצים ליצור מסמכי חיוב. מודל מס לתוכניות של תעריפים עם חלוקת הכנסות, שמזהה את סוג מסמכי החיוב הנדרשים. הערכים החוקיים כוללים: גילוי נאות: ספק ה-API פועל כסוכן גילוי נאות של המפתח. ההכנסה ברוטו (כולל מיסי מכירה) שנאספת ממשתמש הקצה מועברת למפתח. העמלה של ספק ה-API נאספת מהמפתח בצורת חשבונית עמלות. ספק ה-API לא מטפל במס המכירות שנגבה ממשתמש הקצה, והמפתח אחראי לדווח על מס המכירות. לא ידועה: ספק ה-API פועל כסוכן לא ידוע של המפתח, ומנכה את המס שנאסף ממשתמשי הקצה ומשלם אותו לרשויות המס המקומיות. המפתח ינפיק חשבונית לספק ה-API על חלקו מההכנסה נטו (ללא מיסי מכירה ועמלת ספק ה-API). היברידי: ספק ה-API פועל כסוכן שמצוין בגילוי הנאות של המפתח. עם זאת, ספק ה-API משלם את מס המכירות שנאסף מהמנויים שלו לרשויות המס המקומיות בשם המפתח. ספק ה-API מעביר את יתרת ההכנסות למפתח, ולאחר מכן מעביר חשבונית על חיובים בעמלות.	לא רלוונטי	כן
taxNexus	המדינה שבה הארגון רשום לצורכי מס.	לא רלוונטי	לא
taxRegNo	מספר הרישום של הארגון במס או מספר הרישום שלו במס ערך מוסף (מע"מ), אם רלוונטי. המאפיין הזה הוא אופציונלי כי מספר הרישום במס או מספר רישום המע"מ לא רלוונטיים בכל המדינות. המספר שתזינו לפרמטר הזה יופיע בתחתית מסמכי החיוב.	לא רלוונטי	לא
transactionRelayURL	כתובת ה-URL של מערכת אחרת שאליה אפשר להעביר עסקאות, כמו מחסן נתונים.	לא רלוונטי	לא
timezone	מזהה אזור הזמן של הפעילות של הארגון, למשל America/New_York או Europe/Paris. אפשר גם להשתמש בקיצורי שם של אזורי זמן, כמו UTC,‏ EST (שעון החוף המזרחי) או CET (שעון מרכז אירופה).	לא רלוונטי	כן

שינוי של הגדרות פרופיל המונטיזציה של חברה או של מפתח אפליקציות

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

• ניהול מאפיינים מותאמים אישית למפתחי אפליקציות
• ניהול חברות ומפתחי אפליקציות
• ניהול מפתחי אפליקציות